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:

KeyInhaltDatentyp
bodyDie angefragten InhalteArray/Objekt
code0 bei Erfolgt, 1 im FehlerfallInteger
messageEine Erfolgs- oder FehlermeldungString
extraZusätzliche Informationen zu Fehlern oder InhaltenArray

...

Codeblock
titleBeispiel-Response
{
    "body": {
		shopArticleSku": "00001",
        "name": "Visitenkarte allgemein",    
	},
    "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
402401Fehlerhafte Authentifizierungs- oder Autorisierungsanfrage oder abgelaufener Zugriffstoken
403Fehlende Rechte zum Ausführen der Anfrage
404Nicht existente Ressource oder fehlende Pflichtparameter
405Falscher Request-Typ für die angefragte Ressource
500Fehler auf Serverseite

...