Die RESTful API ist Domain-Sensitiv und über den Endpunkt /rest/v5 erreichbar.
Request
Parameter
Alle Parameter eines Requests müssen mit Content-Type application/x-www-form-urlencoded URL-kodiert übertragen werden.
Request-Methoden
Es werden 4 gängige HTTP-Request-Methoden verwendet:
| Request-Typ | Verwendungszweck | ||||
|---|---|---|---|---|---|
| Datenholung | ||||
| Datenanlage | ||||
| Datenmanipulation | ||||
| Datenlöschung |
Request-Header
Mit Ausnahme der Authentifizierungs-Anfrage muss jeder Request einen Autorisierungs-Header Authorization enthalten, der den zuvor abgeholten Zugriffstoken enthält.
Mehr dazu hier.
Aufbau
Eine RESTful-Ressource setzt sich aus folgenden Teilen zusammen:
...
Beispiel: http://www.meinedomain.com/rest/v5/accesstoken
Rückgabewerte
Die Response erfolgt immer im JSON-Format mit Content-Type application/json und Charset UTF-8 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 | ||
|---|---|---|
| ||
{
"body": {
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "abcdefg",
"refresh_token": "hijkl"
},
"code": 0,
"message": ""
} |
Anker HTTP-Status-Codes 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 |
...