Schnittstelle und Plugins

Schnittstelle und Plugins

Kunden, welche die emmasbox Softwaresuite über unsere API in ihre Anwendungen einbinden möchten, stellen wir einen Webservice zur Verfügung, welcher mittels REST die Übermittlung von Informationen ermöglicht. Alternativ zu dieser Schnittstelle können Shop-Plugins zur Einbindung in Onlineshops verwendet werden. Zudem steht unseren Kunden eine vollständige Testumgebung (Sandbox) zur Verfügung, welche eine idente Kopie der Produktivumgebung darstellt und rein fiktive Datensätze beinhaltet.

Bei Rückfragen zur API oder zu den Shop-Plugins stehen wir Ihnen jederzeit gerne zur Verfügung.

1. Workflow

1.1 Begriffserklärungen

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. 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.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

3.4 Sandbox

3.5 Beispiel

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.