Versionen im Vergleich

Schlüssel

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

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.

...

Beispiel: http://www.meinedomain.com/rest/v5/accessToken

Services

Rückgabewerte

Die Response erfolgt immer im JSON-Format mit Content-Type application/json und Charset UTF-8 und enthält folgende Keys:

KeyInhalt
bodyDie angefragten Inhalte
code0 bei Erfolgt, 1 im Fehlerfall
messageEine Erfolgs- oder Fehlermeldung
extraZusätzliche Informationen zu Fehlern oder Inhalten

...

Codeblock
titleBeispiel-Response
{
    "body": {
        "token_type": "Bearer",
        "expires_in": 3600,
        "access_token": "abcdefg",
        "refresh_token": "hijkl"
    },
    "code": 0,
    "message": "",
    "extra": []
}

Anker
HTTP-Status-Codes
HTTP-Status-Codes

Anker
#HTTP-Status-Codes
#HTTP-Status-Codes
Die Schnittstelle antwortet mit folgenden HTTP-Status-Codes:

HTTP-Status-Code

Verwendungszweck
200Erfolgreicher Request
400Fehlerhafte Authentifizierungs- oder Autorisierungsanfrage
403Fehlende Rechte zum Ausführen der Anfrage
404Nicht existente Ressource oder fehlende Pflichtparameter
405Falscher Request-Typ für die angefragte Ressource
500Fehler auf Serverseite

...