RGPD — données minimisées. Les endpoints de suivi n’exposent que des coordonnées et des horodatages. Aucune donnée d’identité du convoyeur (nom complet, téléphone, e-mail) n’est renvoyée par ces endpoints. Le suivi géographique est une donnée de localisation rattachée à l’exécution du contrat de transport.
Vue d’ensemble
Positions GPS
GET /transports/{id}/positions — la trace du convoyeur (latitude, longitude, vitesse, cap, horodatage), filtrable par date avec since.Étapes planifiées
GET /transports/{id}/waypoints — les étapes du trajet avec leur ETA et la date de passage.Authentification
Toutes les requêtes de suivi utilisent l’en-têteX-Api-Key et requièrent le scope transports:read.
404 Not Found (jamais 403), afin de ne pas révéler son existence.
Positions GPS du convoyeur
Paramètres
Identifiant de la mission (
offer_id).Date ISO 8601 (
date-time). Ne renvoie que les positions postérieures à cette date. Idéal pour ne récupérer que les nouveaux points depuis votre dernier appel.Taille de page. Valeur par défaut 100, maximum 500.
Curseur opaque de pagination renvoyé par la page précédente.
Réponse
La réponse est un objet contenant un tableaudata de positions.
Liste des positions relevées.
Exemple
Réponse 200
Cet endpoint renvoie un objet
{ "data": [...] } borné par limit, sans champ next_cursor. Pour ne récupérer que les nouveaux points entre deux appels, mémorisez le dernier ts reçu et repassez-le dans le paramètre since.Étapes planifiées (waypoints)
Paramètres
Identifiant de la mission (
offer_id).Taille de page. Valeur par défaut 100, maximum 500.
Réponse
Liste des étapes planifiées.
Exemple
Réponse 200
Webhooks plutôt que polling
Interroger les positions en boucle serrée (polling intensif) consomme votre quota de débit pour, la plupart du temps, ne rien apprendre de nouveau. Le modèle recommandé est événementiel : laissez l’API vous notifier des changements, et ne consultez les positions qu’au bon moment.Configurez un endpoint webhook
Depuis votre profil client, déclarez une URL HTTPS qui recevra les événements de votre groupe. Conservez le
signing secret montré une seule fois pour vérifier les signatures.Réagissez aux événements de progression
Les événements de cycle de vie (
transport.status_changed, transport.assigned, transport.collected, transport.completed, transport.incident) vous indiquent quand l’état de la mission évolue. C’est le bon déclencheur pour rafraîchir le suivi.Bonne pratique : un suivi pull-on-demand piloté par webhooks reste à jour tout en restant sous les limites de débit, contrairement à un polling fixe toutes les quelques secondes.
Gestion des erreurs
Les erreurs suivent la RFC 9457 (Content-Type: application/problem+json).
401 Unauthorized
401 Unauthorized
403 Forbidden
403 Forbidden
Scope
transports:read absent de la clé. Demandez une clé disposant du bon scope.404 Not Found
404 Not Found
Mission introuvable, ou hors du groupe rattaché à votre clé. Vérifiez l’
id.Exemple d'erreur 404
Étapes suivantes
Détail d'une mission
Statut public, prix, dates et résumé des documents d’une mission.
Webhooks
Recevez les événements en temps réel et vérifiez la signature HMAC.
Journal d'événements
Réconciliez les événements manqués via
GET /events.