Votre clé d'API et votre premier appel
L'API Ultineo Logistics permet à votre propre logiciel d'ajouter et de lire des colis, de lire le catalogue des transporteurs et de gérer votre carnet d'adresses. Son adresse est https://api.logistic.ultineo.com/v1/.
Créer une clé d'API
- Dans l'espace de travail, ouvrez le menu de votre projet et cliquez sur Accès API.
- Créez une clé, donnez-lui les scopes dont elle a besoin, puis copiez-la : elle n'est affichée qu'une fois. L'article Clés d'API détaille l'écran.
| Scope | Donne |
|---|---|
parcel:read | lire vos colis et leurs événements de suivi |
parcel:write | ajouter, modifier, mettre en pause, relancer et supprimer des colis |
carrier:read | lire le catalogue des transporteurs |
address:read | lire votre carnet d'adresses |
address:write | ajouter, modifier et supprimer des adresses |
Faire votre premier appel
Envoyez la clé comme jeton bearer :
curl https://api.logistic.ultineo.com/v1/carrier/list?q=UPS \
-H "Authorization: Bearer VOTRE_CLE" Chaque réponse est un JSON à trois champs : code (le statut HTTP), title et response. Une liste répond object, total, limit, offset et data ; limit vaut au plus 100.
Lire les erreurs
| Code | Signification |
|---|---|
| 400 | Un champ obligatoire manque : le message le nomme. |
| 401 | Aucune clé d'API valide fournie. |
| 402 | Plus de suivi de colis : achetez des suivis ou activez la recharge automatique. |
| 403 | La clé n'a pas le scope requis : le message le nomme. |
| 404 | La ressource n'existe pas. |
| 409 | Déjà présent : la réponse porte l'id du colis ou de l'adresse qui le détient. |
| 413 | Un lot porte plus de 100 colis. |
| 422 | Une valeur est refusée : le message dit laquelle et pourquoi. |