...
Die REST und SOAP Schnittstellen werden ab Version 4.80.2 über OAuth2 mit dem Grant Type Client Credentials geschützt. Eine Client ID und ein Client Secret kann über die Benutzerverwaltung erstellt werden:
...
| Method | POST |
| HTTP Request Header | Content-Type: application/json |
Body:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
| Codeblock | ||||
{
"grant_type": "client_credentials",
"client_id": "[Client ID]",
"client_secret": "[Client Secret]"
} |
Antwort:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"access_token": "[Access Token]",
"expires_in": "3600000",
"token_type": "Bearer"
} |
...
| HTTP Request Header | authorization: Bearer [Access Token] |
Beispiel in Request-Header:
Hier befindet sich die offizielle Spezifikation des Bearer Tokens.
Ein Access Token ist für 60 Minuten gültig. Danach muss ein neues Token angefordert werden.
...
Über Swagger UI kann das Token ebenfalls erzeugt werden, um die REST-API auszutesten. Dazu mit einem Klick auf den Eintrag "/auth/token" den Bereich ausklappen und via "Try it out"-Button weitere Eingabefelder einblenden. Nun können im Request Body die oben beschriebenen Parameter eingetragen werden:
...
Danach erhält man mit einem Klick auf "Execute" eine Antwort vom Server, welche das Token (im Bild gelb markiert) beinhaltet:
...
Dieses wird dann für weitere API-Aufrufe in Swagger UI hinterlegt. Dazu auf den Button "Authorize" am Anfang der Seite klicken und im aufgehenden Fenster das Token hinterlegen:
Danach mit dem Button "Authorize" die Eingabe bestätigen. Nun können die API-Aufrufe via Swagger UI getätigt werden.
...