Skip to main content
AccueilBlogGuidesAPI de suivi UPS : guide du débutant pour bien démarrer

API de suivi UPS : guide du débutant pour bien démarrer

17TRACK

L’API de suivi UPS permet à une entreprise de récupérer le statut d’un envoi et d’afficher les mises à jour de livraison sur son propre site web, son application, son système de gestion des commandes ou ses outils de service client. Pour commencer, il faut généralement créer un compte développeur UPS, enregistrer une application, obtenir des identifiants d’authentification, envoyer une demande de suivi et traduire la réponse en événements utiles pour les clients. Ce guide explique le processus sans supposer de connaissances préalables en matière d’API.

Ups Tracking Api a Beginner S Guide to Getting Started

Les exemples portent sur le suivi plutôt que sur la création d’étiquettes, le calcul des tarifs ou la validation des adresses. UPS propose des produits et une documentation API distincts. Vérifiez donc que l’application que vous enregistrez dispose de l’accès à la fonctionnalité de suivi dont vous avez besoin avant de créer des flux de production.

Ce que fait une API de suivi UPS

Une API est un moyen structuré permettant à un système logiciel de demander des informations à un autre. Dans un flux de suivi, votre système envoie un identifiant d’envoi, tel qu’un numéro de suivi, à un transporteur ou à une plateforme de suivi. Le service renvoie des données d’expédition pouvant inclure un statut actuel, une description du statut, des informations de localisation, des dates et des étapes clés du colis, selon le service, l’envoi et les champs de réponse disponibles au moment de la demande.

Ces données peuvent prendre en charge plusieurs fonctionnalités pratiques :

  • Une page de suivi intégrée à une boutique e-commerce.
  • La visibilité des envois dans un système de gestion des commandes ou de planification des ressources de l’entreprise.
  • Des écrans de service client réduisant le besoin de consulter manuellement le site web d’un transporteur.
  • Des alertes internes concernant les incidents de livraison, les retards ou les livraisons terminées.
  • Des messages post-achat basés sur les événements d’expédition.

L’API ne remplace pas la logique de votre application. Vous devez toujours décider à quelle fréquence demander les mises à jour, comment stocker les réponses, comment gérer les données incomplètes et comment expliquer les statuts du transporteur aux clients.

API de suivi UPS et site web UPS

Le site web UPS est conçu pour qu’une personne saisisse un numéro de suivi et lise le résultat. Une API est conçue pour les logiciels. Elle est utile lorsque les informations de suivi doivent apparaître automatiquement dans un autre système ou déclencher un processus interne.

Cette distinction est importante, car une intégration API implique des responsabilités qui n’existent pas lors d’une recherche manuelle. Votre équipe doit protéger les identifiants, valider les données saisies par les utilisateurs, enregistrer correctement les demandes et les réponses, gérer les défaillances temporaires et vérifier que l’intégration continue de fonctionner après les modifications apportées à la plateforme du transporteur.

La plateforme développeur UPS constitue le point de départ approprié pour connaître les exigences actuelles en matière d’inscription et de technique. Sa documentation doit primer sur les anciens tutoriels, exemples de code ou publications de forums, car les méthodes d’authentification, versions d’API, en-têtes requis et règles d’accès aux produits peuvent changer.

Ce dont vous avez besoin avant d’effectuer une demande

Préparez les éléments suivants avant d’écrire l’intégration :

  1. Un compte développeur UPS. Utilisez le portail officiel UPS Developer Portal pour consulter les API disponibles et créer une application.
  2. Les identifiants de l’application. Les noms exacts des identifiants et le flux d’authentification doivent être tirés de la documentation UPS actuelle. Ne placez pas les secrets client dans du code exécuté dans le navigateur, des applications mobiles, des dépôts publics ou des pages visibles par les clients.
  3. Un numéro de suivi valide pour les tests. Effectuez les tests avec des envois auxquels votre organisation est autorisée à accéder et évitez d’exposer des données d’expédition personnelles ou commerciales dans les journaux.
  4. Un point d’intégration côté serveur. Un service backend est généralement plus sûr qu’un appel direct au transporteur depuis une page web publique, car il peut conserver les identifiants privés et contrôler le volume des demandes.
  5. Un plan de stockage des réponses. Décidez des champs dont vous avez besoin, de leur durée de conservation et de la manière d’associer un événement du transporteur à une commande interne.

Flux d’intégration adapté aux débutants

1. Confirmer le besoin métier

Commencez par définir ce que signifie le « suivi » dans votre produit. Une page destinée aux clients peut n’avoir besoin que du statut actuel et des informations de livraison prévues. Un tableau de bord d’entrepôt ou d’assistance peut également nécessiter l’historique des scans, les horodatages, les descriptions des incidents et le numéro de suivi d’origine.

Évitez de demander tous les champs disponibles sans raison. Un modèle de données plus réduit est plus facile à maintenir et moins susceptible d’exposer des informations dont vos utilisateurs n’ont pas besoin.

2. Enregistrer l’application

Créez une application dans l’environnement développeur UPS et sélectionnez le produit de suivi concerné conformément aux instructions actuelles du portail. Enregistrez l’identifiant de l’application de manière sécurisée. Si UPS exige une approbation, une association de compte ou une configuration supplémentaire pour l’accès à la production, effectuez ces étapes avant de promettre une date de lancement en direct.

Conservez des identifiants et une configuration distincts pour les tests et la production lorsque la plateforme prend en charge ce modèle. Cela réduit le risque qu’un script de test affecte un flux actif.

3. Mettre en œuvre l’authentification

L’authentification prouve que votre application est autorisée à appeler le service. Suivez la méthode d’authentification, le point de terminaison du jeton, les exigences de portée et le format des en-têtes indiqués dans la documentation UPS actuelle. Traitez les jetons d’accès comme des secrets temporaires et ne les écrivez pas dans les journaux de l’application.

Une mise en œuvre pertinente demande un jeton uniquement lorsque cela est nécessaire, le réutilise pendant sa durée de validité autorisée et en obtient un nouveau après son expiration. Votre code doit également distinguer un échec d’authentification d’une erreur de numéro de suivi. Le remède est différent : le premier nécessite de vérifier les identifiants ou la configuration, tandis que le second peut nécessiter une validation des données saisies.

4. Envoyer une demande de suivi

Après l’authentification, envoyez une demande en utilisant l’opération de suivi et le format d’identifiant spécifiés par UPS. L’URL exacte, la méthode HTTP, les en-têtes et le schéma de réponse relèvent de la documentation officielle de la version d’API que vous sélectionnez.

Une demande conceptuelle ressemble à ceci :

POST /tracking-operation
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "trackingNumber": "YOUR_TRACKING_NUMBER"
}

Il s’agit d’un exemple pédagogique, et non d’une demande de production à copier-coller. Remplacez le nom de l’opération, le point de terminaison, les en-têtes et le corps par les valeurs indiquées dans la référence actuelle de l’API UPS. Certaines API utilisent un paramètre de chemin ou une structure de demande différente.

5. Normaliser la réponse

Les réponses des transporteurs ne sont pas toujours rédigées dans la langue attendue par vos clients. Créez un modèle d’événement interne avec des champs stables tels que :

  • Identifiant interne de la commande ou de l’envoi.
  • Nom du transporteur et numéro de suivi.
  • Dernier code de statut du transporteur et description brute.
  • Statut normalisé utilisé par votre application.
  • Horodatage de l’événement et, lorsqu’elle est fournie, localisation.
  • Heure de la dernière mise à jour réussie.

Conservez autant que possible le statut d’origine du transporteur. Une étiquette normalisée telle que « En transit » est utile pour une interface client, mais la description brute peut aider le personnel d’assistance à examiner un événement inhabituel.

6. Décider comment récupérer les mises à jour

Certains systèmes utilisent l’interrogation planifiée : un backend vérifie les envois éligibles à des intervalles définis et enregistre les changements. D’autres utilisent des notifications d’événements lorsque la plateforme concernée les prend en charge. Ne supposez pas que tous les produits de suivi UPS proposent le même mécanisme de notification. Consultez la documentation et les conditions commerciales actuelles avant de concevoir un flux basé sur des webhooks.

L’interrogation doit être sélective. Les colis récemment expédiés ou en mouvement peuvent justifier des vérifications plus fréquentes que les envois livrés ou annulés. Appliquez des nouvelles tentatives avec temporisation progressive en cas de défaillances temporaires, respectez les limites documentées et cessez les demandes inutiles après un état final, sauf si votre processus métier exige une vérification ultérieure.

Erreurs courantes et méthodes de traitement

SituationRéponse probableAction pratique
Échec d’authentificationLa demande n’est pas autorisée.Vérifiez les identifiants, la gestion des jetons, les portées, l’environnement et les en-têtes requis.
Donnée de suivi non valideL’identifiant est absent, mal formé ou refusé.Validez la donnée saisie et affichez un message clair indiquant comment la corriger.
Aucun événement utile pour le momentL’envoi n’a peut-être pas encore reçu son premier scan.Évitez de déclarer un échec de livraison ; affichez un message neutre d’attente et réessayez plus tard.
Réponse de limitation ou de quotaL’application envoie des demandes trop rapidement ou a atteint une limite.Réduisez l’interrogation, mettez le travail en file d’attente et suivez les recommandations du fournisseur.
Erreur temporaire du serveur ou du réseauLe service peut être brièvement indisponible.Réessayez de manière sûre avec une temporisation progressive et conservez le dernier statut connu.

La règle la plus importante en matière d’expérience utilisateur est de ne pas transformer des données manquantes en conclusion certaine. « Aucun nouveau scan » ne signifie pas automatiquement « perdu », et « étiquette créée » ne signifie pas nécessairement « en transit ». Associez soigneusement les statuts et rendez la gestion des exceptions visible pour les équipes d’assistance.

Quand une API multitransporteurs est-elle mieux adaptée ?

Une intégration directe avec UPS peut être un choix pertinent lorsque vos envois sont principalement pris en charge par UPS et que votre équipe souhaite contrôler directement la connexion au transporteur. En contrepartie, chaque transporteur supplémentaire peut nécessiter un autre modèle d’authentification, un autre schéma de données, une autre politique d’erreur et un autre processus de maintenance.

Si votre activité utilise plusieurs transporteurs, un service multitransporteurs peut réduire le nombre d’intégrations distinctes. L’API de suivi de 17TRACK est conçue pour le suivi des envois depuis des applications, et sa documentation officielle pour les développeurs explique le modèle d’intégration disponible. Elle peut être intéressante lorsque le besoin réel ne se limite pas au suivi UPS, mais consiste à disposer d’une couche de suivi cohérente entre plusieurs transporteurs.

Cela ne signifie pas qu’il faut automatiquement remplacer une connexion directe à UPS. Comparez la couverture des transporteurs dont vous avez besoin, le niveau de détail des événements, les exigences de conservation des données, le modèle d’authentification, les limites opérationnelles, le processus d’assistance et l’effort total de mise en œuvre. La documentation publique d’un fournisseur doit être considérée comme le point de départ d’une preuve de concept technique, et non comme un substitut aux tests réalisés avec vos propres scénarios d’expédition.

Liste de contrôle avant la mise en production

  • Les identifiants sont stockés dans un gestionnaire de secrets et ne sont jamais exposés au navigateur.
  • Les environnements de test et de production sont clairement séparés.
  • Les demandes disposent de délais d’expiration, de nouvelles tentatives contrôlées et d’une journalisation utile des erreurs.
  • Les numéros de suivi sont validés avant leur envoi.
  • Le système stocke la dernière mise à jour réussie et évite de la remplacer par une réponse vide.
  • Les messages bruts du transporteur et les étiquettes destinées aux clients sont traités séparément.
  • La fréquence d’interrogation respecte les limites publiées par le fournisseur et vos besoins opérationnels.
  • La surveillance peut détecter les échecs d’authentification, l’augmentation des taux d’erreur et les envois dont les données sont obsolètes.
  • Le personnel d’assistance peut consulter suffisamment de détails pour examiner la question d’un client.
  • L’intégration est retestée lorsque UPS modifie sa documentation, ses identifiants, ses points de terminaison ou ses champs de réponse.

Commencez par un parcours complet : vous authentifier, suivre un envoi de test, stocker la réponse, afficher un statut simple et gérer les échecs. N’élargissez le périmètre qu’une fois ce parcours fiable. Cette approche est généralement plus sûre que de créer une vaste expérience de suivi destinée aux clients avant d’avoir compris les données sous-jacentes et le comportement en cas d’erreur.

FAQ

Ai-je besoin d’une API si je ne suis que quelques colis ?

Généralement, non. Le suivi manuel sur le site du transporteur peut être plus pratique pour des recherches occasionnelles. Une API devient plus utile lorsque le suivi fait partie d’un flux répétitif ou doit apparaître dans une autre application.

Puis-je appeler l’API de suivi UPS depuis un thème Shopify ou un navigateur ?

Un appel direct depuis le navigateur peut exposer les identifiants et rendre le contrôle des demandes difficile. Un service côté serveur ou une intégration de suivi établie est généralement plus sûr. Vérifiez les exigences techniques et l’architecture autorisée dans la documentation UPS actuelle.

Une API de suivi crée-t-elle des étiquettes d’expédition ?

Pas nécessairement. Le suivi, la création d’étiquettes, le calcul des tarifs, la validation des adresses et les autres fonctions logistiques peuvent correspondre à des produits API distincts. Sélectionnez le produit correspondant à l’opération dont vous avez besoin.

Pourquoi un numéro de suivi valide peut-il renvoyer peu d’informations ?

Un colis peut ne pas avoir reçu son premier scan, les données peuvent ne pas être encore disponibles, ou la demande peut ne pas respecter le format requis par l’API ou les autorisations d’accès. Considérez une réponse vide ou limitée comme un état à examiner, et non comme la preuve que l’envoi est perdu.

Dois-je choisir UPS directement ou une API de suivi multitransporteurs ?

Choisissez une connexion directe lorsque UPS est votre principal transporteur et que vous souhaitez une intégration ciblée. Envisagez un service multitransporteurs lorsque votre objectif opérationnel est de disposer d’un flux de suivi unique pour plusieurs transporteurs. Testez les transporteurs et les scénarios d’événements requis avant de prendre une décision définitive.

Sources

Loading