-
Notifications
You must be signed in to change notification settings - Fork 0
REST API Dokumentation
Postman Dokumentation und Beispiele
Bei dem Autentifizierungtyp handelt es sich um einen Bearer Token, welcher im Authorization Header gesendet wird. Die Berechtigungen der Token lassen sich in der Datenbank unter der Tabelle token nachlesen und befinden sich im Payload unter permissions. Den Token erhält man über "get token". Dieser ist nicht Laufzeit beschränkt.
Wenn der Token nicht registriert ist, entspricht response den Code 88. Wenn der Token registriert ist, aber nicht die Berechtigung auf die geforderten Rechte zugewiesen hat ist der response Code 99.
Es müssen immer alle notwendigen Inputs angegeben werden. Wenn ein oder mehrere Inputs fehlen ist der response Code 400. Der http_response_code wird ebenfalls zurückgegeben.
Jede Response besteht aus einer message und response. Bei der response handelt es sich um einen Code, der aussagt, ob der Prozess der Anfrage erfolgreich war, oder wenn nicht, um welchen Fehlercode es sich handelt. In message wird der Fehler/Prozess kurz erläutert. Der Fehlercode steht auch immer im http_response_code.
Codes:
| Code | Beschreibung |
|---|---|
| 400 | ein oder mehrere Inputs fehlen, Input falsch |
| 401 | Token ist nicht autorisiert |
| 200 | Anfrage wurde erfolgreich bearbeitet |
Bei dem Request Book gibt es spezielle Response Codes, welche in dem Kapitel Book erläutert werden.