Integrationsansatz

Der Guide verfolgt einen mehrstufigen und modularen Ansatz.
Integrationen können schrittweise aufgebaut und bei Bedarf erweitert werden – vom einfachen Einstieg bis zur vollständigen, API-gestützten Tourenplanung.

Typische Ausbaustufen sind:

Einstieg mit minimalem Funktionsumfang (z. B. Aufträge anlegen)
optionale Erweiterung um Touren, Zuweisungen und Statussteuerung
Nutzung von Stammdaten, Detailinformationen und erweiterten Planungsfunktionen

Dabei wird bewusst zwischen Kernprozessen, Stammdaten und Detail-/Erweiterungsfunktionen unterschieden.

Technische Referenz

Die vollständige technische API-Referenz (Swagger / OpenAPI) ist bereits vorhanden und beschreibt alle verfügbaren Endpunkte, Parameter und Datenstrukturen.

Dieser Integrationsguide ergänzt die Referenz um:

praxisnahe Abläufe
empfohlene Integrationspfade
Beispiele und Best Practices

👉 Die technische Basis (API-URL, Authentifizierung, Swagger) wird im Kapitel
„API – Überblick & Grundlagen“ beschrieben.

Aufbau der API-Dokumentation

Die API-Dokumentation ist thematisch gegliedert.
Je nach Integrationsziel können einzelne Kapitel unabhängig voneinander genutzt werden.

🔹 API – Überblick & Grundlagen

Technischer Einstieg und Voraussetzungen

API-Basis-URL
Swagger / OpenAPI
Authentifizierung & Zugriff

👉 https://wiki.dedefleet.de/books/tourenplanung/chapter/api-uberblick-grundlagen

🔹 API – Tourenplanung (Integrationspfad)

Kernprozess: Auftrag → Tour → Freigabe

Auftrag anlegen
Touren erstellen
Aufträge Touren zuweisen
Touren berechnen, optimieren und freigeben
Aufträge im Planungsprozess ändern (Update / Unassign / Delete)

👉 https://wiki.dedefleet.de/books/tourenplanung/chapter/api-tourenplanung-integrationspfad

🔹 API – Auftragsdetails, Formulare & Leergut

Erweiterte Informationen auf Auftragsebene

Formulardaten
Lieferscheindetails
Items / Leergut
auftragsbezogene Zusatzinformationen

👉 https://wiki.dedefleet.de/books/tourenplanung/chapter/api-auftragsdetails-formulare-leergut

🔹 API – Stammdaten

Zentrale Referenzdaten für Planung und Ausführung

Kunden
Mitarbeiter / Fahrer
Locations / Standorte
Fahrzeuge

👉 https://wiki.dedefleet.de/books/tourenplanung/chapter/api-stammdaten

🔹 API – Erweiterte Planung

Fortgeschrittene Planungsfunktionen

Multi-Touren-Optimierung
komplexe Planungsszenarien

👉 https://wiki.dedefleet.de/books/tourenplanung/chapter/api-erweiterte-planung

🔹 API – Abfragen & Rückmeldungen

Daten abrufen & Rückmeldungen verarbeiten

Abruf von Aufträgen
Abruf von Touren
Status- und Ergebnisdaten
Formulardaten und App-Rückmeldungen

👉 https://wiki.dedefleet.de/books/tourenplanung/chapter/api-abfragen-ruckmeldungen

Empfohlene Einstiegspfade

Neue Integration:
→ API – Überblick & Grundlagen
→ API – Tourenplanung (Integrationspfad)
Erweiterung bestehender Integrationen:
→ gezielt das passende Fachkapitel auswählen