API-Überblick
Die Freischaltung von Modulen erfolgt durch die Plattformadministration. Ihre Mandantenadministration kann die eigenen Nutzerberechtigungen verwalten und eine benötigte Modulfreischaltung mit dem Support klären; die Admin-Rolle im Mandanten allein erlaubt keine Modulaktivierung.
Neben der Claude-Integration bietet StoryVault eine REST-API für die programmatische Anbindung. Damit können Sie Sitzungen, Transkripte und Projekte in Ihre eigenen Systeme integrieren – zum Beispiel in ein Intranet, ein Qualitätsmanagementsystem oder eine Reporting-Lösung.
Ein API-Schlüssel gilt nur für den Nutzer und den Mandanten, für den er erstellt wurde. Er gewährt keinen Zugriff auf andere Mandanten und erweitert keine Rechte. Für einen anderen Mandanten benötigen Sie dort eine aktive Mitgliedschaft, die passenden Berechtigungen und einen dafür erstellten Schlüssel. Das Modul API und die persönliche API-Berechtigung sind Voraussetzungen.
Die vollständige API-Referenz mit allen Endpunkten, Parametern und Beispielen ist nach dem Anmelden unter dem Menüpunkt API-Dokumentation erreichbar.
Authentifizierung
Abschnitt betitelt „Authentifizierung“Jeder API-Zugriff erfordert einen API-Schlüssel. Der Schlüssel wird als Bearer-Token im Header mitgesendet:
Authorization: Bearer sv_IHR_SCHLUESSEL_HIERAPI-Schlüssel erstellen Sie unter API-Schlüssel. Dafür muss ein Admin Ihnen die Capability API zuweisen.
-
API-Schlüssel erstellen
API-Schlüssel -> “Neuen Schlüssel erstellen”.
-
Name und optionales Ablaufdatum vergeben
Vergeben Sie einen aussagekraeftigen Namen, z.B. “Intranet-Anbindung” oder “Reporting-System”.
-
Schlüssel kopieren
Der Schlüssel wird nur einmal angezeigt. Bewahren Sie ihn sicher auf.
Verfügbare Endpunkte
Abschnitt betitelt „Verfügbare Endpunkte“Die API bietet Zugriff auf die wichtigsten StoryVault-Ressourcen:
| Bereich | Endpunkte | Beschreibung |
|---|---|---|
| Sitzungen | Auflisten, Details, Suche | Sitzungen mit Status, Metadaten und Summary |
| Transkripte | Lesen, Herunterladen | Vollständige Transkripte mit Sprecherzuordnung |
| Projekte | Auflisten, Details | Projekte mit zugehoerigen Sitzungen |
| KI-Chat | Chats auflisten, Nachrichten lesen | Chat-Konversationen und deren Verlaeufe |
| API-Schlüssel | Erstellen, Auflisten, Widerrufen | Verwaltung der eigenen API-Schlüssel |
Rate-Limiting
Abschnitt betitelt „Rate-Limiting“Um einen stabilen Betrieb für alle Nutzenden zu gewaehrleisten, gelten folgende Limits:
| Limit | Wert |
|---|---|
| Anfragen pro Minute pro Schlüssel | 60 |
| Verhalten bei Überschreitung | HTTP 429 (Too Many Requests) |
Wenn Sie das Limit erreichen, warten Sie kurz und versuchen Sie es erneut. Der Retry-After-Header in der Antwort gibt an, wie lange Sie warten sollten.
Zugriffskontrolle
Abschnitt betitelt „Zugriffskontrolle“Der API-Schlüssel ist an einen Nutzenden und eine Organisation gebunden. Die Zugriffsrechte entsprechen der Rolle des Nutzenden:
- Admins können gewöhnliche Projekte ihres Mandanten verwalten; geschützte Projekte, private Chats und Datenschutzrechte haben zusätzliche Regeln.
- Andere Rollen erhalten Inhaltszugriff über Projektzugehörigkeit als Ersteller, direkte Mitgliedschaft oder Gruppe. Sitzungen übernehmen den Projektzugriff.
- Das jeweilige Modul und die Berechtigung für eine Aktion müssen zusätzlich freigeschaltet sein. Ein API-Schlüssel erweitert diese Rechte nicht.
- Wird die API-Capability oder die Mitgliedschaft entzogen, funktionieren vorhandene Schlüssel sofort nicht mehr
Fehler-Responses
Abschnitt betitelt „Fehler-Responses“Die API antwortet mit Standard-HTTP-Statuscodes:
| Code | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Ungültige Anfrage (fehlende oder falsche Parameter) |
| 401 | Nicht authentifiziert (fehlender oder ungültiger Schlüssel) |
| 403 | Keine Berechtigung für diese Ressource |
| 404 | Ressource nicht gefunden |
| 429 | Rate-Limit erreicht |
| 500 | Serverfehler |
Praxis-Beispiele
Abschnitt betitelt „Praxis-Beispiele“Automatischer Export von Transkripten: Ein Traeger exportiert nach jedem Meeting automatisch das Transkript in sein Dokumentenmanagementsystem. Ein Skript fragt regelmaessig neue Sitzungen ab und laedt die Transkripte herunter.
Reporting-Dashboard: Die Geschäftsführung bindet StoryVault-Daten in ein bestehendes Reporting ein: Anzahl der Sitzungen pro Monat, häufigste Themen, KI-Nutzungsstatistiken.
Integration mit QM-Software: Qualitaetszirkel-Protokolle werden automatisch in das QM-System übertragen. Die Zusammenfassungen und Action Items sind sofort in der bestehenden Dokumentation verfügbar.
API-Dokumentation
Abschnitt betitelt „API-Dokumentation“Die vollständige Entwickler-Dokumentation mit Endpunkten, Parametern, Request-/Response-Formaten und Code-Beispielen ist nach dem Anmelden unter dem Menüpunkt API-Dokumentation erreichbar.
Weiterführend
Abschnitt betitelt „Weiterführend“Diese Seite beschreibt die REST-API für den programmatischen Zugriff auf StoryVault.