Dokumentation durchsuchen

API-Schlüssel der Firma, Admin-API und Webhooks

API-Schlüssel der Firma mit Verwaltungsrechten anlegen, verbundene Apps widerrufen und Zusammenfassungen und Mitgliederereignisse per Webhook senden.

Im Bereich Integrationen & API liegen die API-Schlüssel Ihrer Firma, die Apps, die Mitglieder mit ihren Firmenkonten verbunden haben, und Ihre Webhooks. API-Schlüssel und Webhooks gibt es im Team- und im Enterprise-Plan.

API-Schlüssel und Webhooks verwalten Inhaber und Administratoren. Mitglieder-Admins (und im Enterprise-Plan eigene Rollen mit Mitglieder verwalten) sehen nur die Verbundenen Apps.

API-Schlüssel

API-Schlüssel der Firma sind für Ihre eigenen Programme und Skripte, die die öffentliche API von Kalima aufrufen. Siehe REST-API.

Wählen Sie unter API-Schlüssel die Schaltfläche Schlüssel erstellen.

Tragen Sie unter Name eine Bezeichnung ein, an der Sie den Schlüssel später wiedererkennen.

Wählen Sie die Berechtigungen: Lesen (Aufnahmen, Transkripte, Zusammenfassungen, Projekte und Exporte abrufen) und bei Bedarf Schreiben (Aufnahmen hochladen, umbenennen und verschieben, Projekte anlegen, Sprecher benennen, Zusammenfassungen und Links zum Teilen erstellen).

Wählen Sie die Gültigkeit: 30, 90, 180 oder 365 Tage oder Unbegrenzt.

Wählen Sie Erstellen und kopieren Sie den Schlüssel. Kalima zeigt ihn nur einmal. Ihr Programm sendet ihn bei jedem Aufruf im Header Authorization: Bearer mit.

Gut zu wissen:

Ein Schlüssel handelt im Namen der Person, die ihn erstellt hat, und sieht nur, was diese Person in Kalima sieht.
Ist diese Person gesperrt, ruht der Schlüssel, bis die Sperre aufgehoben ist. Verlässt sie die Firma, funktioniert der Schlüssel nicht mehr.
Ihr Plan muss Zugang zur öffentlichen API enthalten, und er begrenzt die Zahl der Schlüssel. Die Liste zeigt, wie viele Sie nutzen.
Sind Zapier und die öffentliche API oder API-Schlüssel unter Richtlinien ausgeschaltet, lässt sich kein Schlüssel anlegen, und die API lehnt bestehende Schlüssel ab.
Widerrufen stoppt einen Schlüssel endgültig.

Verwaltung der Firma (Admin-API)

Beim Anlegen eines Schlüssels erlaubt der Abschnitt Verwaltung der Firma, dass Ihre eigenen Programme die Firma über die API verwalten, etwa wenn Sie kein SCIM nutzen. Für Mitglieder, Teams und Richtlinien wählen Sie jeweils Kein Zugriff, Lesen oder Lesen und ändern:

Mitglieder: Mitglieder abrufen; mit Lesen und ändern auch Personen einladen, Rollen ändern, sperren und wieder freischalten.
Teams: Teams abrufen; mit Lesen und ändern auch Teams anlegen und umbenennen, Personen hinzufügen oder herausnehmen und die Teamleitung festlegen. Löschen lassen sich Teams über die API nicht.
Richtlinien: die Richtlinien abrufen; mit Lesen und ändern auch ändern, außer den Löschregeln (Aufnahmen automatisch löschen, Audio getrennt löschen und Zero Data Retention).

Grenzen der Verwaltungsrechte:

Verwaltungsrechte geben nur Inhaber und Administratoren an einen Schlüssel. Der Schlüssel handelt mit ihren Rechten, und nur solange sie diese Rolle haben.
Einen zweiten Faktor fragt die API bei den einzelnen Änderungen nicht ab. Jede Änderung steht im Audit-Log unter dem Namen des Schlüssels.
Auf Aufnahmen geben Verwaltungsrechte keinen Zugriff.
Gelten erlaubte Netzwerke für die Console, gelten sie auch für die Admin-API.

Bewahren Sie einen solchen Schlüssel so sicher auf wie ein Passwort.

Verbundene Apps

Verbundene Apps listet die KI-Apps (etwa Claude und ChatGPT), andere MCP-Clients sowie Zapier, Make und n8n, die Mitglieder mit ihrem Firmenkonto verbunden haben, mit Person und App. Eine App sieht nur, was die Person in Kalima sieht. Was private Konten verbinden, sieht die Firma nicht.

Mit Widerrufen beenden Sie eine Verbindung. Ab ihrer nächsten Anfrage bekommt die App keine Daten mehr aus diesem Konto. Die Person kann sie wieder verbinden, solange Ihre Richtlinien das erlauben.

Webhooks

Webhooks senden Ereignisse Ihrer Firma an HTTPS-Adressen Ihrer Wahl. Wählen Sie Webhooks verwalten und dann Webhook hinzufügen. Verwaltet werden sie von Inhabern und Administratoren.

Geben Sie Name und Adresse ein: eine HTTPS-Adresse, die POST-Anfragen mit JSON annimmt, auf Port 443 oder ab Port 1024.

Wählen Sie die Ereignisse.

Kopieren Sie das Signatur-Secret und hinterlegen Sie es beim Empfänger. Kalima zeigt es nur einmal.

Mit Testen senden Sie ein einzelnes Testereignis.

Ereignisse

Ereignis	Wann	Inhalt
Zusammenfassung fertig (`summary.ready`)	Eine Zusammenfassung ist fertig oder wurde geändert	ID, Titel, Team und Projekt der Aufnahme sowie der Text der Zusammenfassung mit ihrer Sprache. Nie Audio, nie das Transkript.
Mitglied beigetreten (`member.joined`)	Eine Einladung wurde angenommen, oder SCIM hat ein Konto angelegt	Benutzer-ID, E-Mail-Adresse und Rolle
Mitglied entfernt (`member.removed`)	Jemand wurde entfernt, ist ausgetreten oder die Mitgliedschaft endete. Eine Sperre zählt nicht.	Benutzer-ID, E-Mail-Adresse und Rolle

Für welche Aufnahmen Zusammenfassungen gesendet werden

Zusammenfassung fertig sendet Kalima nur für Aufnahmen, die Ihre Teams schon sehen können: in einem Team-Arbeitsbereich oder in einem Projekt, das mit einem ganzen Team geteilt wurde (auch in dessen Unterprojekten). Private Aufnahmen und Aufnahmen, die nur mit einzelnen Personen oder per Link geteilt sind, sendet Kalima nie. Das prüft Kalima beim Speichern der Zusammenfassung und noch einmal direkt vor dem Senden.

Ein Zusammenfassungstext mit mehr als 100.000 Zeichen wird gekürzt.
Erlauben Ihre Richtlinien den Export für Mitglieder nicht, oder nicht im Format Markdown-Zusammenfassung, kommt das Ereignis ohne den Text der Zusammenfassung an.

Zustellung und Signatur

Bis zu 5 Adressen je Firma. Kalima sendet nur an öffentliche Adressen und folgt keinen Weiterleitungen.
Jede Anfrage trägt den Header Kalima-Signature mit Zeitstempel und einer HMAC-SHA256-Signatur über Zeitstempel und Inhalt. Lehnen Sie Anfragen ab, deren Zeitstempel älter als fünf Minuten ist. Neues Secret erzeugen ersetzt das Secret sofort.
Ereignisse kommen meist binnen einer Minute an. Kalima liefert jedes Ereignis mindestens einmal; doppelte erkennen Sie an ihrer id.
Antwortet der Empfänger nicht binnen 10 Sekunden mit einem 2xx-Status, versucht Kalima es bis zu zehnmal erneut, in wachsenden Abständen von bis zu einer Stunde. Schlägt die Zustellung 24 Stunden lang fehl, pausiert Kalima die Adresse. Ereignisse aus der Zeit einer Pause sendet Kalima nicht nach.
Zustellungen zeigt die letzten 50 Zustellungen ohne ihren Inhalt. Kalima löscht die Einträge nach 30 Tagen.
Solange Zapier und die öffentliche API in Ihren Richtlinien ausgeschaltet ist, sind Webhooks aus. Ereignisse aus dieser Zeit werden auch später nicht gesendet.