Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

BezeichnungWert
Zugriffstoken Gültigkeitsdauer (Sekunden)3600
Aktualisierungstoken Gültigkeitsdauer (Sekunden)30879000
Brandbox-Backend Token Gültigkeitsdauer (Sekunden)1800

Authentifizierung

Für jeglichen Zugriff muss eine Authentifizierung stattfinden. Die initiale Authentifizierung erfolgt Alle Zugriffe auf die Schnittstelle benötigen einen Zugriffstoken. Dieser lässt sich mit einer Authentifizierungsanfrage auf den Endpunkt accesstoken erhalten. Dazu kann entweder eine Benutzername/Passwort-Kombination oder ein Erneuerungstoken verwendet werden.
Da Erneuerungstokens mit dem Zugriffstoken ausgeliefert wird, muss eine initiale Authentifizierung mindestens einmalig immer mit einem brandbox-User auf den Endpunkt accesstoken:erfolgen.

Status
titlePOST

Ressource
/rest/v5/accesstoken

Parameter

ParameterWert
grant_type"password" für die Authentifizierung mit brandbox-User oder "refresh_token" für die Authentifizierung per Erneuerungstoken
client_idMandanten-ID
client_secret"clientSecret" (fester Wert)
usernameBenutzername, nur bei grant_type "password"
passwordPasswort, nur bei grant_type "password"
refresh_tokenErneuerungstoken, nur bei grant_type "refresh_token"

Response

KeyWertDatentyp
token_type"Bearer" (fester Wert)string
expires_inGültigkeit in Sekundeninteger
access_tokenZugriffstoken für die Autorisierung von Folge-Requestsstring
refresh_tokenErneuerungstoken für die Anforderung eines neuen Zugriffstokensstring