API Reference
Authorization
Learn how to authenticate with the enneo API
To obtain an authorization token for the use of the enneo API, the following options are available to API users depending on the use case.
1. User-JWT-Token for development
Users can generate a personal access token by navigating to their profile page and clicking on the "Create API Key" button. It is important to save this key as it is only displayed once.
2. Service-Worker-JWT-Token for periodic tasks
A service worker token can be used by selecting an existing service worker or creating a new one at Settings → User → Service Worker. Once a service worker is selected, users can generate an API key by clicking the "Create API Key" button. It is crucial to save this key as it is only displayed once.
These tokens only expire when they are revoked or recreated on the User → Service Worker page.
3. OAuth2-Session-Token
API service workers or users can log in with single-sign-on (SSO) credentials via the /api/auth endpoints to receive a session token. The SSO backend, typically Microsoft Azure OAuth2 or Google OAuth2, then validates against enneo. If the validation is successful, enneo issues a session token with a validity of 24 hours that can be used as access data for API requests. This method is more complex and is therefore usually only used in advanced infrastructure setups.
Note
Within AI functions, authentication against the enneo API endpoints is not required. The SDK handles the authorization.
Remember to securely store and manage your authorization tokens in order to ensure the safety and integrity of your API interactions.
Use of the token
Once you have the token, it can be passed as a bearer token in the header, as shown in this example:
curl --header 'Authorization: Bearer eyJhbGciOiJI...' \
'https://demo.enneo.ai/api/mind/ticket/6'