Zum Inhalt springen

Übersicht

Basis-URL, Konventionen und alle Endpoints.

Text
https://runner.cargoduo.com/v1

JSON über HTTPS. Längen in cm, Gewichte in kg, Beträge in Credits.

Endpoints

Ladeplanung

EndpointSeiteBerechtigung
POST /v1/packJob erstellenpack:write
POST /v1/estimateJob-Kosten schätzenpack:write

Jobs

EndpointSeiteBerechtigung
GET /v1/jobsJobs auflistenjobs:read
GET /v1/jobs/{id}Job abrufenjobs:read
GET /v1/jobs/{id}/resultJob-Ergebnis abrufenjobs:read
DELETE /v1/jobs/{id}Job abbrechenpack:write

Projekte

EndpointSeiteBerechtigung
GET /v1/projectsProjekte auflistenresources:read
POST /v1/projectsProjekt erstellenresources:write
GET /v1/projects/{id}Projekt abrufenresources:read
PATCH /v1/projects/{id}Projekt aktualisierenresources:write
DELETE /v1/projects/{id}Projekt löschenresources:write
POST /v1/projects/{id}/packProjekt berechnenpack:write und resources:write

Fahrzeuge

EndpointSeiteBerechtigung
GET /v1/vehiclesFahrzeuge auflistenresources:read
GET /v1/vehicles/{id}Fahrzeug abrufenresources:read
POST /v1/vehiclesFahrzeug erstellenresources:write
PATCH /v1/vehicles/{id}Fahrzeug aktualisierenresources:write
DELETE /v1/vehicles/{id}Fahrzeug löschenresources:write

Vorlagen

EndpointSeiteBerechtigung
GET /v1/templatesVorlagen auflistenresources:read
GET /v1/templates/{id}Vorlage abrufenresources:read
POST /v1/templatesVorlage erstellenresources:write
PATCH /v1/templates/{id}Vorlage aktualisierenresources:write
DELETE /v1/templates/{id}Vorlage löschenresources:write

Konto

EndpointSeiteBerechtigung
GET /v1/limitsLimits abrufenaccount:read
GET /v1/balanceGuthaben abrufenaccount:read
GET /v1/usageNutzung abrufenaccount:read
HeaderRichtungBedeutung
AuthorizationAnfrageBearer cd_live_…
Content-TypeAnfrageapplication/json bei POST
Idempotency-KeyAnfrageSichere Wiederholungen von POST /v1/pack und POST /v1/projects/{id}/pack
X-Request-IdAntwortAnfrage-ID (req_…), bei jeder Antwort
X-RateLimit-Limit / -Remaining / -ResetAntwortDas strengste Rate-Limit-Fenster
X-Credits-RemainingAntwortVerfügbare Credits nach der Anfrage
Retry-AfterAntwortWartezeit in Sekunden, bei 429
Idempotent-ReplayedAntworttrue, wenn ein Schlüssel einen früheren Job wiederholt hat

Maschinenlesbar

Siehe auch