API-Basis-URL & API-Referenz (Swagger)

API-Referenz (Swagger / OpenAPI)

Die vollständige technische Dokumentation aller verfügbaren Endpunkte, Parameter und Datenstrukturen ist über Swagger verfügbar:

https://ortung.dedefleet.de/swagger/?url=https://ortung.dedefleet.de/swagger/data/api/2

Die Swagger-Dokumentation dient als:

• Referenz für alle Endpunkte

• Quelle für vollständige Feldbeschreibungen

• Grundlage für Validierungsregeln und Datentypen

Zusammenspiel von Integrationsguide & Swagger

Dieser Integrationsguide:

• erklärt typische Abläufe und Integrationsschritte

• zeigt praxisnahe Beispiele

• beschreibt Konsequenzen im System

Die Swagger-Dokumentation:

• beschreibt alle verfügbaren API-Endpunkte

• enthält vollständige Request-/Response-Schemas

• ist maßgeblich für technische Details

🔎 Empfehlung:
Nutzen Sie diesen Guide für den Einstieg und die Prozesslogik
und Swagger für Detailfragen zur API-Referenz.

Beispiel: Zusammengesetzter API-Aufruf

Endpoint:

POST /orders

Vollständige URL:

https://ortung.dedefleet.de/data/api/2/orders

Authentifizierung

Für alle API-Aufrufe ist ein gültiger Bearer Token erforderlich, der zuvor im DeDeFleet-Portal erzeugt wurde.

Der Token kann auf zwei Arten übergeben werden.

Variante 1 (empfohlen) – Bearer Token im HTTP-Header

Authorization: Bearer <BEARER_TOKEN>
Accept: application/json
Content-Type: application/json

Beispiel (curl)

curl -X POST "https://ortung.dedefleet.de/data/api/2/orders" \
  -H "Authorization: Bearer <BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Variante 2 – Bearer Token als URL-Parameter

?token=<BEARER_TOKEN>

Beispiel (curl)

curl -X POST "https://ortung.dedefleet.de/data/api/2/orders?token=<BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

⚠️ Sicherheitshinweis:
Für produktive Integrationen wird die Übergabe des Tokens im HTTP-Header empfohlen, da Tokens in URLs in Logs oder Browser-Historien erscheinen können.