Authentification

Clés API, autorisations et listes d'adresses IP autorisées.

Envoyez une clé API comme jeton Bearer dans chaque requête /v1.

Bash

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

Clés API

Clé	Détail
Format	`cd_live_` + 40 caractères
Créée par	Le propriétaire de l'organisation, dans la console développeur
Affichée	Une seule fois, à la création. Seul un hash est stocké
Par organisation	Jusqu'à 20 clés actives
Facultatif	Date d'expiration, liste d'adresses IP autorisées (adresses IP ou plages CIDR)
Renouvellement	Nouveau secret, mêmes paramètres. L'ancien cesse immédiatement de fonctionner

Conservez les clés sur votre serveur. N'en intégrez jamais dans un navigateur ou une application mobile.

Autorisation	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}`

Les nouvelles clés reçoivent toutes les autorisations (scopes). POST /v1/projects/{id}/pack nécessite à la fois pack:write et resources:write.

Statut	Code	Signification
401	`unauthorized`	Clé API absente, mal formée ou inconnue.
401	`key_revoked`	La clé a été révoquée.
401	`key_expired`	La clé a dépassé sa date d'expiration.
403	`ip_not_allowed`	L'adresse IP appelante ne figure pas dans la liste des adresses IP autorisées de la clé.
403	`subscription_inactive`	L'organisation n'a aucun abonnement actif incluant l'API.
403	`account_inactive`	L'organisation est suspendue ou n'a aucun propriétaire dont le compte est actif.
403	`scope_missing`	Il manque à la clé une autorisation requise par cet endpoint.
429	`rate_limited`	Trop de requêtes dans la minute, l'heure ou la journée en cours (par clé ou par organisation), ou plus de 60 échecs d'authentification par minute depuis votre adresse IP.