Seitenvergleich

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.

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-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:

• Protokoll

• Hostname (Domain)

• Schlüsselwort für den RESTful-Endpunkt

• Schnittstellen-Version

• Ressourcen-Endpunkt

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:

Beispiel-Response

{
    "body": {
		shopArticleSku": "00001",
        "name": "Visitenkarte allgemein",    
	},
    "code": 0,
    "message": "",
    "extra": []
}

Fehler-Codes: Im Fehlerfall wird in message eine Fehlermeldung mit Fehlercode zurückgegeben: