API Referenz
Autorisierung
Erfahren Sie, wie Sie sich mit der enneo API authentifizieren
Um ein Autorisierungstoken für die Nutzung der enneo API zu erhalten, stehen API-Nutzern je nach Anwendungsfall folgende Optionen zur Verfügung.
1. User-JWT-Token für die Entwicklung
Nutzer können einen persönlichen Zugriffstoken generieren, indem sie zu ihrer Profilseite navigieren und auf die Schaltfläche „API-Schlüssel erstellen“ (Create API Key) klicken. Es ist wichtig, diesen Schlüssel zu speichern, da er nur einmal angezeigt wird.
2. Service-Worker-JWT-Token für periodische Aufgaben
Sie können einen Service-Worker-Token verwenden, indem Sie in den Einstellungen → Benutzer → Service Worker einen bestehenden Service Worker auswählen oder einen neuen erstellen. Sobald ein Service Worker ausgewählt ist, können Nutzer durch Klicken auf die Schaltfläche „API-Schlüssel erstellen“ (Create API Key) einen API-Schlüssel erzeugen. Es ist entscheidend, diesen Schlüssel zu speichern, da er nur einmal angezeigt wird.
Diese Tokens sind ein Jahr gültig; das Ablaufdatum steht in der Schlüsselliste des Service Workers. Dort lässt sich jeder Schlüssel auch einzeln widerrufen.
3. OAuth2-Session-Token
API-Service-Worker oder Nutzer können sich mit Single-Sign-On-(SSO)-Anmeldedaten über die /api/auth-Endpunkte anmelden, um ein Session-Token zu erhalten. Das SSO-Backend, typischerweise Microsoft Azure OAuth2 oder Google OAuth2, validiert anschließend gegenüber enneo. Ist die Validierung erfolgreich, stellt enneo ein Session-Token mit einer Gültigkeit von 24 Stunden aus, das als Zugangsdaten für API-Anfragen verwendet werden kann. Diese Methode ist komplexer und wird daher in der Regel nur in fortgeschrittenen Infrastruktur-Setups eingesetzt.
Note
Innerhalb von KI-Funktionen müssen Sie sich nicht gegenüber den enneo-API-Endpunkten autorisieren. Das SDK übernimmt die Autorisierung.
Denken Sie daran, Ihre Autorisierungstokens sicher zu speichern und zu verwalten, um die Sicherheit und Integrität Ihrer API-Interaktionen zu gewährleisten.
Verwendung des Tokens
Sobald Sie das Token haben, können Sie es als Bearer-Token im Header übergeben, wie in diesem Beispiel:
curl --header 'Authorization: Bearer eyJhbGciOiJI...' \
'https://demo.enneo.ai/api/mind/ticket/6'Sitzungs-Cookies und andere Websites
Eine Anfrage, die sich nur mit dem Sitzungs-Cookie des Browsers anmeldet und von einer anderen Website kommt, lehnt enneo mit 403 cross_origin_request_refused ab. Integrationen verwenden deshalb immer einen der oben genannten Tokens im Authorization-Header.
API-Schlüssel für einen anderen Benutzer
Einen API-Schlüssel für einen anderen Benutzer erzeugt POST /api/mind/jwt/{id}; GET auf dieselbe Adresse wird nicht mehr unterstützt. Der Aufrufer braucht das Recht, das Profil dieses Benutzers zu bearbeiten, und die Rolle des Benutzers darf nicht mehr Rechte haben als die eigene. Mehr dazu unter Sitzungen, Passwörter und Zugriffe.