REST-API

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 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/{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
1	POST	/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.

Rückgabewerte/Response codes

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

200 OK

GET, PUT oder DELETE Kommando war erfolgreich.

201 Created

POST Kommando war erfolgreich.

400 Bad request

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

401 Unauthorized

Der Benutzer ist nicht angemeldet.

403 Forbidden

Der Benutzer hat keine Rechte um die Anfrage auszuführen.

404 Not found

Das Ziel konnte nicht gefunden werden.

500 Internal Server Error

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 codiert. Die Rückgabe erfolgt im Json-Format.