API & Schlüssel
Agents und Agent Gruppen können über eine REST-API in bestehende Anwendungen integriert werden. Auch die Data Push API zur Datenübertragung an den AI Hub wird über API-Schlüssel gesichert.
Die vollständige API-Dokumentation mit allen Endpunkten und Parametern finden Sie in der Swagger OpenAPI Collection.
API-Schlüssel
Jeder API-Zugriff erfordert einen API-Schlüssel. Schlüssel werden im Bereich API Keys der Admin-Oberfläche erstellt und verwaltet.
Schlüssel erstellen
Beim Erstellen eines API-Schlüssels wird konfiguriert:
- Typ: Bestimmt, wofür der Schlüssel verwendet wird:
| Typ | Beschreibung |
|---|---|
| Agent | Ermöglicht den Zugriff auf einen bestimmten Agent über die Chat-API |
| Agent Gruppe | Ermöglicht den Zugriff auf eine Agent Gruppe über die Chat-API |
| Data Push | Ermöglicht das Senden von Daten an eine bestimmte Data Push Collection |
- Name: Ein beschreibender Name zur Identifikation des Schlüssels.
- Beschreibung (optional): Zweck oder Einsatzbereich des Schlüssels.
- Gültig bis (optional): Ablaufdatum. Nach diesem Datum funktioniert der Schlüssel nicht mehr. Ohne Angabe ist der Schlüssel unbefristet gültig.
Öffentlich vs. Geheim
Für Agent- und Agent-Gruppe-Schlüssel wird zusätzlich zwischen öffentlichen und geheimen Schlüsseln unterschieden:
- Öffentlich: Kann in browserseitigen Anwendungen (z. B. eingebetteten Widgets) verwendet werden. Es müssen erlaubte Domains angegeben werden — der Schlüssel funktioniert nur auf diesen Domains.
- Geheim: Darf nur in serverseitigen Anwendungen verwendet werden und sollte niemals im Browser-Code sichtbar sein.
Der API-Schlüssel wird nach dem Erstellen einmalig angezeigt und automatisch in die Zwischenablage kopiert. Speichern Sie den Schlüssel sicher — er kann danach nicht mehr eingesehen werden.
Schlüssel verwalten
Bestehende Schlüssel können nachträglich bearbeitet werden (Name, Beschreibung, erlaubte Domains). Der Schlüssel selbst kann nicht geändert oder erneut angezeigt werden.
Beim Löschen eines Schlüssels wird darauf hingewiesen, dass der Schlüssel in allen Anwendungen und Systemen ersetzt werden muss, in denen er verwendet wird.