Versionen im Vergleich

Schlüssel

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

...

Jedes Kommando für die API – Schnittstelle ist ein eine HTTP Anfrage.

In der URL wird das Ziel das gewünschte Datenobjekt angegeben und die HTTP Methode (GET, POST, PUT, DELETE) gibt an, was gemacht werden soll.

...

Verfügbare Daten

Bestellung

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

GET/api/order/{orderCode}- http://shop.printlounge.local/api/order/PDLOID
PUT/PATCH/api/order/{orderCode}-{"orderStatus":"137"}http://shop.printlounge.local/api/order/PDLOID

Nachbestellung

Nr

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
1POST/api/vw/reorder/-

{
"dealerNumber":"42",
"destId":"25",
"destPage":"/starterpage"
}

http://shop.printlounge.local/api/vw/reorder/ 

 

Erklärung zu Nr. 1

Die "destId" und "destPage" ist die Referenznummer des Werbemittels.

...

Es wird ein entsprechender HTTP Statuscode zurückgegeben um den ErfolgErfolgs- oder Fehlerfall mitzuteilen.  

...

Alle Anfragen und Rückgabewerte sind UTF-8 kodiertcodiert. Die Rückgabe erfolgt im Json-Format.