Zum Hauptinhalt springen
Alle REST-Schnittstellen der OSB-Dienste sind gleich aufgebaut. Wer einen Dienst angebunden hat, kann den nächsten mit demselben Gerüst ansprechen und muss nur Dienstkennung, Aktion und Parameter austauschen.

​
Aufbau der URL

Kennt ein Dienst die übergebene Aktion nicht, antwortet er mit dem HTTP-Code 400 für Bad Request.

​
Token im Header

Jeder Aufruf braucht ein gültiges Token. Wie Sie es erzeugen, steht unter REST-Authentifizierung. Übergeben wird es im Request-Header:
Das Token ist ein JSON Web Token und besteht aus drei Teilen:
  1. Header mit dem Algorithmus der Signatur und der Art des Tokens.
  2. Payload mit den Informationen, die bei einem CGI-Aufruf im Kontext stehen, dazu ein Timestamp für die Gültigkeit.
  3. Signatur, ein verschlüsselter Hash aus Header und Payload.
Ein Token ist 30 Minuten gültig. Danach beantwortet die API jede Anfrage mit dem Statuscode 401 und Sie fordern ein neues an. Bauen Sie das in Ihre Anbindung ein, bevor Sie einen länger laufenden Ablauf automatisieren.

​
Fehlerbehandlung

Jeder Dienst gibt einen zum Vorfall passenden HTTP-Code zurück. Der wichtigste Fall ist immer gleich: Wer ohne gültiges Token auf eine Ressource zugreift, erhält 401.

​
Verwandte Themen