...
Damit ein Script sich an der Schnittstelle autorisieren kann, müssen die "HTTP Basic Authorization" Daten im HTTP - Header mitgeschickt werden.
...
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/{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 |
|---|
"2":{
"orderCode":"FHYSEK",
"dealerNumber":"4711"
},
"1":{
"orderCode":"QKTRWB",
"dealerNumber":"42"
}
}
"2":{
"orderCode":"FHYSEK",
"dealerNumber":"4711"
},
"
| 1 |
"dealerNumber":"42"
}
}
| POST | /api/vw/reorder/ | - | { | http://shop.printlounge.local/api/vw/reorder/ |
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ückgegeben.
Erklärung zu Nr 3
Die "article_idDie "destId" und "destPage" ist die Referenznummer des Werbemittels.
...
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.