Die REST RESTful API ist Domain-Sensitiv und über den Endpunkt /rest/v5 erreichbar.
Inhalte, die als GET-Parameter oder im POST Body übertragen werden, müssen unbedingt URL-Encodiert werden.
JSON Rückgaben können nicht als Plaintext aus dem Request verwendet werden, hier muss vorher eine JSON Dekodierung erfolgen, da im JSON Format zum Teil Sonderzeichen maskiert werden.
Parameter
Alle Parameter müssen mit Content-Type application/x-www-form-urlencoded URL-kodiert übertragen werden.
Rückgabewerte
Die Response erfolgt immer im JSON-Format mit Content-Type application/json und enthält folgende Keys:
| Key | Inhalt |
|---|---|
| body | Enthält die eigentlichen angefragten Inhalte |
| code | 0 bei Erfolgt, 1 im Fehlerfall |
| message | Eine Erfolgs- oder Fehlermeldung |
| Codeblock |
|---|
Request-Typen
Es werden 4 gängige HTTP-Request-Methoden verwendet:
| Request-Typ | Verwendungszweck |
|---|---|
| GET | Datenholung |
| POST | Datenanlage |
| PUT | Datenmanipulation |
| DELETE | Datenlöschung |
HTTP-Status-Codes
Die Schnittstelle antwortet mit folgenden HTTP-Status-Codes:
| HTTP-Status-Code | Verwendungszweck |
|---|---|
| 200 | Erfolgreicher Request |
| 400 | Fehlerhafte Authentifizierungs- oder Autorisierungsanfrage |
| 403 | Fehlende Rechte zum Ausführen der Anfrage |
| 404 | Nicht existente Ressource oder fehlende Pflichtparameter |
| 405 | Falscher Request-Typ für die angefragte Ressource |
| 500 | Fehler auf Serverseite |