Beim Scrollen durch unsere Website dürften Sie ein paar Mal auf den Begriff „API“ gestoßen sein. Dabei handelt es sich um eine Abkürzung aus dem IT-Bereich, den wir in diesem Beitrag gerne etwas näher erläutern möchten, um Ihnen bestenfalls ein weiteres Nutzungspotenzial für EasyCargo zu geben. Es soll darum gehen, was eine API ist und wie sie funktioniert. Vielleicht kann es auch Ihnen dabei helfen, die softwarebasierten Abläufe in Ihrem Unternehmen zu optimieren. Unser Leitfaden ist dabei in drei Teile gegliedert. In Teil 1 geht es um die theoretischen Grundlagen, am Ende des Beitrags gibt es auch einen Ausblick auf den Inhalt der kommenden Serienteile.

 

Die Rolle der API

Quelle: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg

 

Das Diagramm, welches Sie oben sehen, stellt die Aufgabe einer API-Schnittstelle sehr vereinfacht dar. Um die Frage dennoch im Vornherein zu beantworten – was ist eine API eigentlich? Ausgeschrieben steht API für Application Programming Interface. Es gibt verschiedene Arten von APIs – wir stellen die Variante REST API bereit. Die genaue lexikalische Bedeutung davon ist nicht so wichtig, es soll allgemeiner um APIs gehen. Eine Programmierschnittstelle (dt. Übersetzung für API) ist ein spezifischer Baukasten für Softwarelösungen, mit dem Sie die Daten eines anderen Dienstes/Programms in Ihre eigene Website oder Software integrieren können. Und was bringt das? Wenn Ihr Unternehmen ein internes Programm für die Transportorganisation o.Ä. nutzt, können Sie einfach die Daten aus Ihrem Account in EasyCargo herunterladen und direkt in der Firmensoftware bereitstellen lassen.

 

API-Schlüssel in EasyCargo

Damit Ihr Programm mit EasyCargo oder einer anderen Software kommunizieren kann, brauchen Sie allerdings einen API-Schlüssel. Er hilft uns, Ihr Unternehmen bei der Interaktion mit EasyCargo zu identifizieren. Wenn Sie an einem API-Schlüssel interessiert sind, schreiben Sie uns gerne eine E-Mail an kundensupport@easycargo3d.com oder nutzen Sie unser Kontaktformular. Sobald der Aktivierungsschlüssel für Sie generiert wurde, finden Sie ihn im Nutzerprofil in der oberen rechten Bildschirmecke, indem Sie auf API-Schlüssel anzeigen klicken.

Anmerkung: Gehen Sie mit dem API-Schlüssel wie mit ihrem Passwort um – behalten Sie ihn für sich.

Da wir die wichtigsten Inhalte rund um APIs abgehandelt haben, können wir nun anhand eines Diagramms die Rolle dieser Programmierschnittstelle erläutern.

 

Wie die API funktioniert

Wir hoffen, dass Sie bereits jetzt einen guten Überblick über die Grundidee und Funktionsweise einer API-Schnittstelle haben. Zur Schnittstelle für EasyCargo gelangen Sie über diesen Link. An dieser Stelle müssen wir noch erwähnen, dass alle Abfragebeispiele in der API-Dokumentation mit HTTP geschrieben sind. Wir empfehlen die Nutzung des sichereren HTTPS-Protokolls.

 

API-Dokumentation in EasyCargo

In diesem ersten Teil der Beitragsreihe ging es darum, was eine API überhaupt ist und welche Grundidee dahinter steckt. Der kommende Artikel geht dann schon eher in die praktische Richtung. Dann wollen wir Ihnen die Nutzung der API für EasyCargo näherbringen, u.a. mit Hilfe unseres API-Clienten. Sie werden selbst sehen können, wie entsprechende Anfragen an die EasyCargo-API zu den gewünschten Ergebnissen und Daten führen. Im letzten Teil der Beitragsreihe gehen wir dann darauf ein, was eine Verknüpfung von EasyCargo per API an Ihr System tatsächlich alles ermöglichen kann.

21. Mrz 2022