Der letzte Artikel unserer Serie über die EasyCargo API bietet eine umfassende, schrittweise Anleitung zur Ladeplanung mit der API. Wir führen Sie durch den gesamten Prozess – von der Ersteinrichtung bis hin zum Generieren von Ladeplanberichten – und zeigen dabei die API Interaktionen sowie deren entsprechende Darstellung in der EasyCargo Interface. Dieser Leitfaden baut auf grundlegenden Konzepten auf und stellt gleichzeitig erweiterte Funktionen zur Optimierung der Frachtplanungsprozesse vor.

Bevor Sie in die Implementierungsdetails eintauchen, schaffen Sie eine solide Grundlage mit den folgenden zwei wesentlichen Ressourcen. Unser umfassender API-Theorieleitfaden deckt alle Grundlagen ab, die Sie über APIs wissen müssen, während unser Praxisleitfaden für API-Anfragen und Tests mit ReqBin führt Sie durch die Einrichtung eines API-Clients sowie das Testen von Endpoints. Zusammen legen diese Artikel das notwendige Fundament und bieten einen wichtigen Kontext für die in diesem Artikel behandelten Themen.

Schritt-für-Schritt Ladeplanungsprozess

Um die folgenden API-Anfragen zu verwenden, müssen Sie ein Authentifizierungstoken in Ihrem Anfrage-Header einfügen. Einen detaillierten Authentifizierungsprozess finden Sie in unserem vorherigen Artikel. Um einen Authentifizierungstoken zu erhalten, benötigen Sie einen API-Schlüssel, der mit Ihrem Benutzerkonto verknüpft ist. Wenden Sie sich an unsere Kundenbetreuung, um einen API-Schlüssel anzufordern.

Bitte beachten Sie, dass Authentifizierungstokens aus Sicherheitsgründen nur für 1,5 Stunden gültig sind und danach ablaufen.

Einrichtung eines neuen Benutzers

Der erste und einer der wichtigsten Schritte in unserem Prozess besteht darin, ein Benutzerkonto über die API zu erstellen, zum Beispiel für das Lagerpersonal.

Mit dem Endpunkt /api/v1/users können Sie neue Benutzerkonten mit spezifischen Berechtigungen erstellen. Sie müssen bestimmte Benutzerdaten angeben, wie im folgenden API Request gezeigt. Die Hinzufügung wird sofort in der EasyCargo Umgebung angezeigt, wodurch der Zugriff des Benutzers auf das Unternehmenskonto bestätigt wird. Dieser optimierte Prozess gewährleistet ein effektives Zugriffsmanagement und Sicherheitskontrollen für Ihre Ladeplanungsprozesse.

Im folgenden Codeausschnitt senden wir eine Anfrage an den Endpunkt /api/v1/users mit einem Body, der die Details zu einem Benutzer enthält, für den wir ein Konto erstellen möchten. Wir geben den Vornamen, Nachnamen, die E-Mail-Adresse für die Anmeldung und die Benutzerrolle an. Die Benutzerrolle kann entweder ein Administrator (dargestellt durch eine 1 im Request-Body) oder ein regulärer Benutzer (dargestellt durch eine 2) sein.

Siehe die vollständige Vorlage der API-Anfrage: https://reqbin.com/duacb1ye

Laderäume definieren

Bevor Sie mit der Ladeplanung beginnen, ist es wichtig, die Laderäume zu definieren. Der Endpunkt /api/v1/cargospaces ermöglicht es Ihnen, die Containerabmessungen festzulegen, in denen die Packstücke platziert werden. Jede Laderaum Definition erfordert wichtige Spezifikationen wie Länge, Breite, Höhe und maximale Tragfähigkeit. Derzeit unterstützt die API nur containerartige Laderäume für die Erstellung, mit der Möglichkeit, in zukünftigen Updates auch andere Arten von Laderäumen zu unterstützen. Das System validiert alle Spezifikationen, um sicherzustellen, dass sie den betrieblichen Anforderungen und Sicherheitsstandards entsprechen. Sobald der Laderaum definiert ist, erscheint er in der EasyCargo Interface, was die erfolgreiche Erstellung bestätigt und die sofortige Nutzung für die Ladeplanung ermöglicht.

Im folgenden Codeausschnitt wird eine Anfrage an den Endpunkt /api/v1/cargospaces mit einem Body gesendet, der Details zum Container enthält, mit dem Ziel, einen neuen Laderaum zu erstellen.

Wir geben den Namen, die Breite, die Höhe, die Länge und das maximale Ladegewicht an. Außerdem legen wir das verwendete Maßsystem fest (1 für das metrische System und 2 für das imperiale System) sowie die Art des Laderaums, die auf 1 gesetzt ist und einen Container darstellt. Wie bereits erwähnt, wird derzeit nur dieser Laderaumtyp unterstützt.

Siehe die vollständige Vorlage der API-Anfrage: https://reqbin.com/8ieqp8ey

Verwaltung der zu ladenden Packstücke

Nachdem die Laderäume definiert wurden, besteht der nächste Schritt darin, eine neue Ladung über den Endpunkt /api/v1/shipment-inputs zu erstellen. Dieser Prozess umfasst sowohl die Angabe der Ladungsdetails als auch die einzelnen zu ladenden Packstücke.

Jedes Packstück erfordert umfassende Attribute, darunter die Abmessungen, Gewicht, Handhabungsanforderungen und Stapelbeschränkungen. Die EasyCargo-Oberfläche bietet eine visuelle Bestätigung der erfolgreichen Erstellung der Ladung und zeigt alle Packstücke mit ihren Spezifikationen an. Durch die detaillierte Eingabe über die API gewährleistet eine präzise Ladeplanung ohne Fehler und eine optimale Raumausnutzung in den folgenden Schritten, während gleichzeitig die Einhaltung von Sicherheitsvorschriften und Handhabungsprotokollen sichergestellt wird.

Im folgenden Codeausschnitt erstellen wir eine neue Ladung mit 82 Stück einer Packstück-Art über den Endpunkt /api/v1/shipment-inputs. Im Request geben wir den Namen der Ladung, das Maßsystem und die zu ladenden Packstücke an. Für die Packstücke können wir Details wie Abmessungen und Handhabungsanforderungen festlegen. In diesem Beispiel werden die Packstücke in einer Prioritätsgruppe namens Berlin platziert, da wir die Kühlschränke dorthin liefern möchten. Wir erlauben, dass die Packstücke beim Verpacken im Laderaum drehbar und stapelbar sind.

Beachten Sie, dass es derzeit nicht möglich ist, die Farbe auszuwählen oder zu steuern, ob das Packstück-Etikett angezeigt wird oder nicht – diese Optionen sind über die API aktuell nicht verfügbar.

Siehe die vollständige Vorlage der API-Anfrage: https://reqbin.com/ozixloob

Prozess der Ladungsoptimierung

Sobald die Ladungsdetails festgelegt sind, übernimmt der Optimierungsalgorithmus von EasyCargo die Erstellung effizienter Ladepläne. Obwohl die direkte Auslösung des Optimierungsprozesses über die API derzeit noch in Entwicklung ist, können Benutzer diese Funktion über die EasyCargo-Oberfläche nutzen, indem sie auf die Schaltfläche „Laden“ klicken.

EasyCargo berücksichtigt dabei verschiedene Faktoren wie Gewichtsverteilung, Gruppen-Ladereihenfolge und Ladungsanforderungen, um optimale Anordnungen zu erstellen. Nach der Optimierung haben Benutzer weiterhin die Flexibilität, manuelle Anpassungen vorzunehmen oder die Auswahl des Laderaums zu ändern, sodass der endgültige Plan sowohl den betrieblichen Anforderungen als auch den Einschränkungen entspricht und gleichzeitig die Effizienz maximiert.

Generieren von Ladeplänen

Nach der Finalisierung des Ladeplans wird eine umfassende Dokumentation über den Endpunkt /api/v1/shipment-reports/{id} verfügbar. Diese detaillierten Ladeplanberichte umfassen Ladeanordnungen, 3D-Visualisierungen und schrittweise Ladeanweisungen. Jeder Bericht enthält wichtige Kennzahlen wie Raumausnutzung, Gewichtsverteilungsdaten und spezifische Handhabungsrichtlinien für das Ladepersonal. Das System erstellt sowohl interaktive 3D-Modelle als auch herunterladbare PDF-Anweisungen, um die Zugänglichkeit für alle Beteiligten sicherzustellen – von Lagerangestellten bis hin zu Ihren Kunden. Diese Berichte dienen als unverzichtbare Referenzen während des physischen Ladeprozesses und tragen dazu bei, die Übereinstimmung zwischen geplanter und tatsächlicher Ladungsanordnung sicherzustellen. Schauen Sie sich den Report aus dem Beispiel für alle Details an.

Im folgenden Codeausschnitt rufen wir alle Details des Ladeplanberichts ab, indem wir den Endpunkt /api/v1/shipment-report/{id} verwenden. Zuerst müssen wir die Bericht-ID erhalten, indem wir eine GET-Anfrage an /api/v1/shipments senden. Die Bericht-ID aus dieser Antwort nehmen wir und fügen sie in den URL-Pfad der nächsten Anfrage ein (/api/v1/shipment-report/{id}). Die Antwort enthält alle Details zum Bericht, die Sie im untenstehenden Bild in druckbarer PDF-Form sehen.

Siehe die vollständige Vorlage der API-Anfrage: https://reqbin.com/ust8mrq2

Teilen und Zusammenarbeiten

Die letzte Phase besteht darin, den Ladeplan an relevante Beteiligte über den Endpunkt /api/v1/shipments zu teilen. Diese Funktionalität bietet Zugriff auf umfassende Details der Ladung und zugehörige Berichte, einschließlich interaktiver 3D-Darstellungen des Ladeplans. Beteiligte können auf den Plan über eine öffentliche URL zugreifen, was eine Echtzeitvisualisierung und Überprüfung der Ladeanordnung ermöglicht. Dieser kollaborative Ansatz stellt sicher, dass alle Teilnehmer des Ladeprozesses sofortigen Zugriff auf die erforderlichen Informationen haben, was die genaue Umsetzung des Ladeplans erleichtert. Sie können die öffentliche URL der Ladung in EasyCargo aufrufen, um die Platzierung der Waren selbst zu sehen.

Im folgenden Codeausschnitt rufen wir alle Details unserer zuvor erstellten Ladung ab, indem wir den Endpunkt /api/v1/shipments/{id} verwenden. Um die Ladungs-ID zu erhalten, senden Sie zuerst eine GET-Anfrage an /api/v1/shipments. Sobald Sie Ihre Ladungs-ID identifiziert haben, senden Sie eine GET-Anfrage an /api/v1/shipments/{id}, um umfassende Ladungsdetails zu erhalten, einschließlich des öffentlichen Links, des Links zum Ladungsreport und anderer unten angezeigter Informationen.

Siehe die vollständige Vorlage der API-Anfrage: https://reqbin.com/y5p3zysj

Fazit

Der Einfluss von APIs auf die IT-Branche ist nicht zu unterschätzen – sie sind zu fundamentalen Bausteinen der modernen Softwarearchitektur und Geschäftsoperationen geworden. Die EasyCargo API zeigt eindrucksvoll, wie gut gestaltete API-Schnittstellen komplexe Logistikoperationen optimieren können, während sie gleichzeitig Präzision und Effizienz gewährleisten.

Wir hoffen, dass diese umfassende Serie wertvolle Einblicke in die Nutzung der EasyCargo API für Ihre Logistikbedürfnisse gegeben hat. Ob Sie neu in der Welt der APIs sind oder ein erfahrener Entwickler – die Möglichkeiten zur Integration sind vielfältig.

Für eine persönliche Beratung zur Implementierung von EasyCargo in Ihrem Betrieb können Sie uns über unser Kontaktformular erreichen. Unser Team ist bereit, Ihnen zu helfen, unsere Lösung auf Ihre spezifischen Anforderungen abzustimmen.