1. Workflow
1.1 Begriffserklärungen
Abhol-Code
Der Abhol-Code dient dem Konsumenten zur Identifizierung bei der Abholung an der
Abholstation. Der Abhol-Code ist eine numerische oder alphanumerische Zeichenfolge,
welche über 2D-Codes (Barcode, QR-Code, etc.) auch graphisch dargestellt werden kann.
Abhol-PIN
Der Abhol-PIN ist eine vom Endverbraucher gewählte Zeichenfolge und kann als
zusätzliches Sicherheitsmerkmal bei der Abholung eingesetzt werden.
Anliefer-Code
Der Anliefer-Code dient der Identifzierung eines Pakets, eines Kartons, einem Brief oder
einer Tüte bei Bestückung der Abholstation. Der Anliefer-Code ist eine numerische oder
alphanumerische Zeichenfolge, welche über 2D-Codes (Barcode, QR-Code, etc.) auch
graphisch dargestellt werden kann.
Zeitslots
Zeitslots sind Zeitfenster, welche als Abholzeitfenster für Endverbraucher definiert werden.
Während eines bei der Onlinebestellung gewählten Zeitfensters können Konsumenten ihre
bestellten Waren abholen. Zeitslots können individuell für jede Abholstation festgelegt
werden.
1.2 Ablauf des Workflows
Zum besseren Verständnis der Schnittstelle als auch der Plugins möchten wir in diesem Abschnitt einen kurzen
Überblick über den alltäglichen Workflow bei Betrieb einer Abholstation geben. Dieser hier aufgezeigte Ablauf ist
möglichst allgemein beschrieben und dient rein exemplarischen Zwecken.
2. API-Token
Sowohl bei Nutzung unserer Schnittstelle als auch bei Einbindung unserer Plugins wird ein API-Token benötigt,
um sich im System anmelden zu können. Sollten Sie über keinen Token verfügen und die Testumgebung der API
nutzen möchten, so nehmen Sie bitte direkt Kontakt mit uns auf.
Haben Sie einen Token von uns erhalten, so behandeln Sie ihn bitte vertraulich; einen neuen Token können wir
Ihnen jederzeit zukommen lassen. Sollten Sie über keinen oder einen ungültigen Token verfügen, erhalten Sie
auf jede Anfrage die Fehlermeldung „401 Unauthorized“ retour.
3. Beschreibung der API
3.1 Einführung
Die Nutzung der Schnittstelle steht Ihnen mittels zweier Technologien offen: REST oder SOAP.
REST verwendet das http-Protokoll im JSON-Format zur Übergabe von Informationen. Für nahezu jede im
Webkontext genutzte Programmiersprache wie Ruby, Java, PHP oder Python existieren Bibliotheken, welche die
Nutzung einer auf JSON-basierten Schnittstelle ermöglichen. Die Verwendung unserer REST-Schnittstelle ist
daher in Regel wesentlich einfacher als die Implementierung mittels SOAP, bei welcher Informationen mittels
xml-Dateien übergeben werden.
3.2 Requests
3.3 Responses und Fehlercodes
200 OK
Die Anfrage war erfolgreich und das
201 Created
Der Eintrag wurde Erstellt.
401 Unauthorized
Der Token bzw. die notwendigen Login-Daten sind ungültig oder nicht vorhanden.
403 Forbidden
Serverfehler beim Authentifizieren der Anfrage. Bitte stellen Sie sicher, dass
Ihre Identifzierung über das richtige Format verfügt und wiederholen Sie Ihre Anfrage.
404 Not Found
Die angegebene Ressource ist nicht vorhanden.
406 Not Acceptable
Das Format der Anfrage ist ungültig.
422 Unprocessable Entity
Die übermittelten Informationen sind ungültig.
500 Internal Server Error
Auf dem Server wurde ein interner Fehler festgestellt, bitte wiederholen Sie Ihre Anfrage.
503 Service Unavailable
Der Server ist derzeit nicht erreichbar, bitte wiederholen Sie Ihre Anfrage zu einem späterem Zeitpunkt.
3.4 Sandbox
3.5 Beispiel
4. Beschreibung der Plugins
Die von uns zur Verfügung gestellten Plugins befinden sich derzeit in Entwicklung und sind noch nicht öffentlich
verfügbar. Bei Interesse sprechen Sie uns bitte direkt an.