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
- Datensätze einer Tabelle (List)
- Eltern eines Datensatzes (Parents)
- Karte eines Datensatzes (Card)
- Kinder eines Datensatzes (Children)
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 | Datentyp |
---|---|---|
body | Die angefragten Inhalte | Array/Objekt |
code | 0 bei Erfolgt, 1 im Fehlerfall | Integer |
message | Eine Erfolgs- oder Fehlermeldung | String |
extra | Zusätzliche Informationen zu Fehlern oder Inhalten | Array |
...
Codeblock | ||
---|---|---|
| ||
{ "body": { "token_type shopArticleSku": "Bearer00001", "expires_inname": 3600, "access_token": "abcdefg"Visitenkarte allgemein", "refresh_token": "hijkl" }, "code": 0, "message": "", "extra": [] } |
Anker HTTP-Status-Codes HTTP-Status-Codes
Die Schnittstelle antwortet mit folgenden HTTP-Status-Codes: Anker #HTTP-Status-Codes #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 |
...