Überblick
Die FleetZip-API ist REST-basiert, per Token authentifiziert und in OpenAPI 3.1 dokumentiert. Alles, was die Plattform über die Oberfläche tut, ist auch über die API möglich.
- Aufträge — Aufträge zum Planen erstellen, aktualisieren und abfragen.
- Touren — Optimierung auslösen, Reihenfolgen abfragen und den Fortschritt verfolgen.
- Ereignisse — Webhooks für Versand, Stopp, Vorfall, Lieferung und Retoure empfangen.
Integrationsdiagramm: links die Systeme des Kunden (ERP, TMS, E-Commerce); in der Mitte FleetZip (REST-API + Webhook-Warteschlange); rechts die Fahrer-App und der Leitstand.
Webhooks pro Ereignis
Konfigurieren Sie Endpunkte, um Benachrichtigungen in Echtzeit zu erhalten. Jedes Ereignis trägt die vollständige Payload und wird bei einem Fehler automatisch erneut zugestellt:
| Ereignis | Wann es ausgelöst wird |
|---|---|
route.dispatched | Tour an die Fahrer-App gesendet |
stop.arrived | Fahrer am Stopp angekommen |
delivery.completed | Lieferung mit Nachweis abgeschlossen |
occurrence.created | Vorfall erfasst (Ablehnung, abwesend…) |
return.created | Retoure abgeholt |
Offizielle SDKs
Bibliotheken, um die Integration zu beschleunigen, mit Authentifizierung, Wiederholungen und Webhook-Validierung an Bord:
- Node, Python und Java — typisierte Wrapper über die REST-API.
Codeausschnitt, der das Erstellen eines Auftrags über das Node-SDK und den Empfang eines Webhooks für eine abgeschlossene Lieferung zeigt.
Für eine Schritt-für-Schritt-Anleitung siehe die Dokumentation.