Seitenvergleich

Auth

Damit ein Script sich an der Schnittstelle autorisieren kann, müssen die "HTTP Basic Authorization" Daten im HTTP Header mitgeschickt werden.

Hierzu sieht dieser Headerbereich wie folgt aus: Authorization: Basic YXBpdXNlcjphcGlrZXk=

Wobei hinter "Basic" der Benutzername und das Passwort, getrennt mit einem Doppelpunkt, Base64 encoded sind. Im Beispiel wären es folgende Zugangsdaten: apiuser:apikey

Wichtig ist zudem, dass der Content-type auf application/json gesetzt ist.

In diesem Beispiel würde folgende Anfrage eine Order mit dem Code "XYZXYZ" abzurufen.

GET /api/order/XYZXYZ HTTP/1.

...

1
Authorization: Basic YXBpdXNlcjphcGlrZXk=
Host: shop.printlounge.local
Accept: */*
Content-type: application/json

API

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.

GET: Liefert einen oder mehrere Datenobjekte.
POST: Erstellt ein neues Datenobjekt.
PUT: Ändert ein bestehendes Datenobjekt.
DELETE: Löscht ein bestehendes Datenobjekt.

Druckdaten über REST API - innerhalb der API geht es aktuell nicht.

Die Druckdaten könnte man sich aber wie folgt abholen:

Vorschau
https://nhan.print-server.net/pdf/softproof/VLATSR/3951978

Druck
https://nhan.print-server.net/pdf/print/VLATSR/3951978

Hinweis
ist für POD Artikel gültig

Verfügbare Daten

Bestellung

HTTP Methode	Pfad	Parameter	Request-Body	Beispiel
GET	/api/order/{

order-code

orderCode}

-

		http://shop.printlounge.local/api/order/PDLOID
PUT/PATCH	/api/order/{

order-code

orderCode}

-

{"

order_status

orderStatus":"137"}

http://shop.printlounge.local/api/order/PDLOID

Nachbestellung

Nr	HTTP Methode	Pfad	Parameter	Request-Body	Beispiel	Rückgabeformat

GET/api/vw/reorder/ http://shop.printlounge.local/api/vw/order/{
"2":{
"order_code":"FHYSEK",

"dealerNumber":"4711"
},
"

1

":{
       "order_code":"QKTRWB",
       "dealerNumber":"42"
      }
}GET

POST

/api/vw/reorder/

date=YYYY-MM-DD http://shop.printlounge.local/api/vw/order?date=2016

-

11-11

"order_code":"FHYSEK",

"

{
"

2":{

dealerNumber":"

4711

42"

}

,
"

1

destId":

{ "order_code":"QKTRWB"

"25",

"

dealerNumber

destPage":"

42

/starterpage"

}

POST/api/vw/reorder/-{"order_code":"XYZXYZ"

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

Notiz für POST: Statt order_code bitte dealerNumber (int) und articleType (string) verwenden.

Erklärung zu Nr. 1

Alle Nachbestellungen die noch nicht über diese Schnittstelle ausgelesen wurden, werden im JSON Format übertragen. Beim nächsten Aufruf werden die ausgegebenen nicht erneut berücksichtigt.

Erklärung zu Nr. 2

Bei Angabe des Filters "date" werden alle, auch die bereits ausgegebenen Nachbestellungen, im JSON Format zurückgegebenDie "destId" und "destPage" ist die Referenznummer des Werbemittels.

Rückgabewerte/Response codes

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

...

POST Kommando war erfolgreich.

400 Bad request

Die Anfrage ist unvollständig oder existiert nicht. Es muss die URL oder Parameter anpepasst werden.

...

Dieser tritt meistens bei Validierungsfehler auf. Die Fehlerinformationen sind im „Body“ der Antwort vorhanden und haben folgenden Aufbau:
{
"error": "Parameter nicht beschreibbar"
}

...

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

Versionen im Vergleich

Alte Version 3

Neue Version Aktuell

Schlüssel