Leitfaden für die EasyCargo API (Teil 2)

Wie im ersten Teil des Leitfadens bereits angedeutet, werden wir uns in diesem Artikel eher der praktischen Seite der EasyCargo API widmen. Dafür werden wir den API-Client nutzen. Die Funktionsweise der API werden wir außerdem anhand des Online-Tools ReqBin erläutern. Es ermöglicht die Kommunikation mit einem Webserver, wodurch die relevanten Daten aus dem Laderaumoptimierungstool EasyCargo heruntergeladen werden können. In der Praxis nutzen Sie wahrscheinlich ein Java-Plugin für Ihre Software oder Javascript-Abrufe aus SAP. Mehr dazu, sowie Beiträge zur Plattform Make und anderen praxisnahen API-Fallbeispielen, lesen Sie in den kommenden Artikeln dieser Beitragsserie.

Hier sehen Sie, wie die oben beschriebene Abfrage in ReqBin aussieht

Das Bild oben zeigt den API-Client für EasyCargo. Um API-Abfragen an den Server senden zu können, muss der Client zunächst autorisiert werden. Sie beginnen also mit der Eingabe des Nutzernamens und des API-Schlüssels in http://go.easycargo3d.com/api/v1/authentication. Als Antwort vom Server erhalten Sie ein Authentifizierungstoken. Jede darauffolgende API-Abfrage sollte authentifiziert werden, indem das erhaltene Token in der Kopfzeile eingefügt wird (sofern nicht anders angegeben). Beachten Sie dabei, dass alle API-Abfragen vom Inhaber des Tokens getätigt werden. Abfragen und Antworten müssen im JSON- oder XML-Format erstellt werden.

Nachdem die Authentifizierung geklappt hat, können wir nun zu den wirklich interessanten Aspekten der API übergehen. Nehmen wir an, Benutzer X hat die folgenden Frachtladungen in seinem Account gespeichert.

Anhand dieser Ladungen werden wir die API-Abfragen üben, da sie wohl der wichtigste Aspekt in der EasyCargo-Software sind. Andere Abfragen, zum Beispiel zur Benutzerverwaltung, sind ähnlich formuliert, sodass Sie nach dem Lesen dieses Artikels auch alle anderen Abfragen problemlos erstellen können. In unserer API-Dokumentation für die Software wird jede Methode und Funktion der Schnittstelle beschrieben und erläutert.

Wenn Sie Zweifel oder Probleme haben, kontaktieren Sie uns bitte über kundensupport@easycargo3d.com oder nutzen Sie unser Kontaktformular.

API-Abfragen zur Ladung

Aus der API-Dokumentation geht hervor, dass wir mit korrekt formulierten Abfragen eine Liste aller Ladungen vom Server abrufen und Daten zu einer bestimmten Ladung aus dem Account in EasyCargo erhalten können. Es können sogar Ladungen erstellt oder aus dem Account entfernt werden.

Liste aller Ladungen erstellen

Hier sehen Sie, wie die oben beschriebene Abfrage in ReqBin aussieht

Daten zu einer bestimmten Ladung bekommen

Hier sehen Sie, wie die oben beschriebene Abfrage in ReqBin aussieht

Eine Ladung erstellen

Hier sehen Sie, wie die oben beschriebene Abfrage in ReqBin aussieht

Wie Sie sehen, wurde die Ladung erfolgreich in Ihrem EasyCargo-Account gespeichert.

Sie können ganz einfach die durch die API erzeugte Ladung in Ihrem System öffnen.

Eine Ladung löschen

Hier sehen Sie, wie die oben beschriebene Abfrage in ReqBin aussieht

Die Ladung wurde mit der entsprechenden Abfrage korrekterweise aus Ihrem EasyCargo-Account gelöscht.

Weitere Details zur API-Schnittstelle

• Die für Sie verfügbare Anzahl an API-Abfragen ist mit 60 Abfragen pro Stunde zeitlich begrenzt. Die Kontingente werden durch einen gleitenden Zeitrahmen überprüft, sodass innerhalb einer bestimmten Zeit nur eine festgelegte Anzahl von Abfragen zur Verfügung steht.

• API-Fehler werden mit den standardmäßigen HTTP-Statuscodes zurückgesendet. In der Regel enthält das Antwortelement eine ausführliche Meldung dazu, was schiefgelaufen ist.

• Die Ladeplankalkulation kann nicht über die API ausgeführt werden.

• Ihr API-Client muss den Zugriff auf die Kopfzeilen für Abfragen und Antworten sowie deren Bearbeitung und das Parsen von JSON- oder XML-Formaten unterstützen.

• API-Nutzer müssen sich in der EasyCargo-Software einloggen, damit die Berechnung eines Ladeplans durchgeführt werden kann.

• Einige API-Funktionen unterstützen die Verwendung optionaler Parameter, wie zum Beispiel „from“. Die Bedeutung der einzelnen Parameter erlernen Sie mithilfe der Dokumentation. Diese Parameter können Sie zum Beispiel nutzen, um eine Nutzdatenliste abzurufen. Fügen Sie die entsprechenden Parameter einfach in der Ressourcenadresse nach dem „?“-Zeichen ein, getrennt durch ein „&“-Zeichen im Bereich name=value, also zum Beispiel: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.

Abschließend lässt sich sagen, dass eine API-Schnittstelle sehr nützlich sein kann. Wir hoffen, dass Ihnen diese Praxisanleitung einen guten Einblick in die Funktionsweise einer Programmierschnittstelle gegeben hat. Dieser Artikel ist der zweite Teil einer Beitragsserie von EasyCargo. Falls Sie den ersten Teil noch nicht gelesen haben, finden Sie ihn hier. Die Schnittstelle eröffnet Ihnen dutzende neue Möglichkeiten. Im nächsten Beitrag erfahren Sie, welche Vorteile Sie durch die Nutzung einer API haben. Zudem zeigen wir Ihnen einige Anwendungsbeispiele aus der Praxis.