Authentifizierung

API-Schlüssel, Berechtigungen und IP-Allowlists.

Senden Sie bei jeder /v1-Anfrage einen API-Schlüssel als Bearer-Token.

Bash

curl https://runner.cargoduo.com/v1/balance \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

API-Schlüssel

Schlüssel	Detail
Format	`cd_live_` + 40 Zeichen
Erstellt von	Organisationsinhaber, in der Entwicklerkonsole
Angezeigt	Einmal, beim Erstellen. Gespeichert wird nur ein Hash
Pro Organisation	Bis zu 20 aktive Schlüssel
Optional	Ablaufdatum, IP-Allowlist (IP-Adressen oder CIDR-Bereiche)
Erneuern	Neuer Schlüssel, gleiche Einstellungen. Der alte funktioniert sofort nicht mehr

Verwenden Sie Schlüssel nur auf Ihrem Server. Betten Sie nie einen Schlüssel in Browser-Code oder eine mobile App ein.

Berechtigung	Endpoints
`pack:write`	`POST /v1/pack`, `POST /v1/estimate`, `DELETE /v1/jobs/{id}`, `POST /v1/projects/{id}/pack`
`jobs:read`	`GET /v1/jobs`, `GET /v1/jobs/{id}`, `GET /v1/jobs/{id}/result`
`account:read`	`GET /v1/limits`, `GET /v1/balance`, `GET /v1/usage`
`resources:read`	`GET /v1/projects`, `GET /v1/projects/{id}`, `GET /v1/vehicles`, `GET /v1/vehicles/{id}`, `GET /v1/templates`, `GET /v1/templates/{id}`
`resources:write`	`POST /v1/projects`, `PATCH /v1/projects/{id}`, `DELETE /v1/projects/{id}`, `POST /v1/projects/{id}/pack`, `POST /v1/vehicles`, `PATCH /v1/vehicles/{id}`, `DELETE /v1/vehicles/{id}`, `POST /v1/templates`, `PATCH /v1/templates/{id}`, `DELETE /v1/templates/{id}`

Neue Schlüssel erhalten alle Berechtigungen. POST /v1/projects/{id}/pack benötigt sowohl pack:write als auch resources:write.

Status	Code	Bedeutung
401	`unauthorized`	API-Schlüssel fehlt, ist fehlerhaft oder unbekannt.
401	`key_revoked`	Der Schlüssel wurde widerrufen.
401	`key_expired`	Der Schlüssel ist abgelaufen.
403	`ip_not_allowed`	Die aufrufende IP-Adresse steht nicht auf der Allowlist des Schlüssels.
403	`subscription_inactive`	Die Organisation hat kein aktives Abonnement, das die API enthält.
403	`account_inactive`	Die Organisation ist gesperrt oder hat keinen Inhaber mit aktivem Konto.
403	`scope_missing`	Dem Schlüssel fehlt eine Berechtigung, die dieser Endpoint benötigt.
429	`rate_limited`	Zu viele Anfragen in der aktuellen Minute, Stunde oder am aktuellen Tag (pro Schlüssel oder pro Organisation) oder mehr als 60 fehlgeschlagene Authentifizierungen pro Minute von Ihrer IP-Adresse.