Utilisation
L’API de repérage de Postes Canada permet à la clientèle de faire le suivi de ses envois en temps réel. Grâce au numéro d’identification du colis, les gens peuvent connaître l’emplacement exact de leurs colis tout au long de leur parcours d’expédition.
Fonctionnement
L’API de repérage utilise les paramètres suivants pour cerner et repérer les colis (ce ne sont pas tous les services de repérage qui utilisent tous les paramètres) :
- Numéro d’identification du colis (NIP) :
Un NIP est attribué par Postes Canada lorsque l’étiquette d’expédition est créée. - Carte Avis de livraison (CAL) :
Un numéro de CAL est indiqué sur la carte et laissé par le personnel de livraison lorsque personne n’est à la maison pour recevoir la livraison. - Paramètres de référence :
Ensemble de critères qui identifie un ou plusieurs colis, comme le numéro de client, le numéro de référence, le code postal de destination et la date d’expédition.
Afficher une liste de toutes les activités de balayage de repérage
Dernières mises à jour de cette version
30 avril 2026
Nous avons mis à jour nos API afin d'améliorer la sécurité et les performances. Les protocoles sont désormais exclusivement REST avec une standardisation au format JSON (XML et SOAP ne sont plus pris en charge), et les jetons OAuth 2.0 Bearer sont maintenant obligatoires pour toutes les requêtes. Nous avons également ajouté des fichiers de configuration YAML et élargi le soutien pour 10 langages de programmation.
Pour en savoir plus, consultez les notes de mise à jour.
Flux de travail du repérage
Le flux de travail du suivi comprend trois étapes : l’API récupère l’événement le plus récent concernant l’article. L’API récupère ensuite des détails sur toutes les activités de livraison pour un seul article. Enfin, l’API obtient une copie du certificat de confirmation de livraison associé à l’article.
Appels de repérage
La fonction propre au service de repérage est offerte avec les appels ci-après :
| Service | Description |
|---|---|
| Obtenir un résumé du repérage | Affiche le plus récent événement de livraison d’un colis, y compris la confirmation de livraison. Le colis est identifié à l’aide du NIP, de la CAL ou d’autres paramètres de référence. |
| Obtenir les détails de repérage | Affiche toutes les activités de repérage d’un colis. Le colis est identifié à l’aide d’un NIP ou d’une CAL. |
| Obtenir le Certificat de confirmation de livraison | Si le colis a été livré, cette fonction affiche un fichier PDF avec le numéro de repérage, le service utilisé, les numéros de référence, la date de livraison, le nom du signataire et l’image de la signature, le cas échéant. Le colis est identifié au moyen d’un NIP seulement. |
Commencer à utiliser l’API
Commencer
Consultez notre guide du développeur pour obtenir des renseignements sur les jetons d’accès, l’authentification, les limites de tarif et plus.
Obtenir du soutien
Trouvez les réponses aux questions courantes dans notre FAQ. Si vous ne les trouvez pas, communiquez avec notre équipe.