L’abonnement aux numéros de suivi de visibilité intégrée avancée est conçu pour permettre aux abonnés de visibilité intégrée avancée de gérer leurs projets de webhook basés sur des numéros de suivi et d’effectuer des opérations liées aux projets, telles que l’ajout de nouveaux numéros de suivi, la modification ou la consultation des détails des tâches, au moyen des points de terminaison d’API.

Note :

• Vous devez disposer d’un accès administrateur ou contributeur à votre projet Visibilité intégrée avancée.
• Pour en savoir plus sur la visibilité intégrée avancée et ses fonctionnalités, consultez la page de documentation Visibilité intégrée avancée.

Les avantages de l’abonnement aux numéros de suivi — Visibilité intégrée avancée sont les suivants :

• Vous pouvez facilement mettre à jour et gérer les numéros de suivi de votre projet Visibilité intégrée avancée en utilisant les points de terminaison de l’API.
• Cette API vous permet d’associer plusieurs numéros de suivi à votre projet en une seule transaction API, au lieu de devoir les associer un par un.
• Vous pouvez soumettre des requêtes API de façon consécutive et consulter les journaux détaillant les réussites et les échecs de ces requêtes.

Utilisez les points de terminaison ci-dessous pour gérer votre projet Visibilité intégrée avancée :

Cette API est accessible uniquement depuis l’aperçu de votre projet, comme illustré dans la capture d’écran ci-dessus.

Utilisez ce point de terminaison pour lancer une tâche asynchrone permettant d’associer un ou plusieurs numéros de suivi à un projet spécifique de visibilité intégrée avancée.

Les renseignements requis pour cette demande sont les suivants :

• Action — Spécifiez l’action à effectuer lors de la soumission de la requête. Exemple : AJOUTER
• Détails du numéro de suivi — Spécifiez le numéro de suivi

Vous pouvez associer jusqu’à 1 000 numéros de suivi dans une seule requête. La réponse positive à cette requête renverra l’identifiant de la tâche (jobID), l’état actuel de la tâche, ainsi que les horodatages de création et de fin de la tâche. Cet identifiant (jobID) pourra ensuite être utilisé pour vérifier l’état de la tâche asynchrone.

Utilisez ce point de terminaison pour obtenir le statut d’une tâche asynchrone (une ou plusieurs requêtes consécutives en file d’attente), ou le statut de toutes les tâches soumises.

Les renseignements requis pour cette demande sont les suivants :

• ID de tâche – Spécifiez l’ID de la tâche dont vous souhaitez consulter le statut.

Remarque : l’ID de tâche est une donnée facultative pour ce point de terminaison. Si vous ne spécifiez pas d’ID, vous obtiendrez alors le statut de toutes les tâches soumises.

La réponse positive à cette requête renverra l’identifiant de la tâche (jobID), l’état actuel de la tâche, ainsi que les horodatages de création et de fin de la tâche. La réponse affichera le statut actuel des tâches. Elle contiendra également des messages de réussite, des erreurs ou des avertissements afin que les utilisateurs puissent les consulter et, le cas échéant, résoudre les problèmes.

• Si le statut de la tâche s’affiche comme COMPLETED (TERMINÉ), cela signifie que tous les numéros de suivi ont été validés et traités avec succès.
  • Le statut COMPLETED (TERMINÉ) indique que les numéros de suivi ont été validés et traités correctement, mais cela ne signifie pas que tous les numéros de suivi ont été ajoutés avec succès au projet Visibilité intégrée avancée.
  • Si vous tentez d’associer plusieurs numéros de suivi et que seuls certains sont associés tandis que d’autres échouent, le statut de la tâche sera malgré tout mis à jour en COMPLETED (TERMINÉ). Pour confirmer le statut de chaque numéro de suivi dans la requête d’association, le rapport de lot doit être téléchargé.

Note :

• Si le statut de la tâche s’affiche comme FAILED (ÉCHOUÉ), cela signifie que, pour diverses raisons ou en raison d’échecs critiques, la requête n’a pas pu être traitée. L’utilisateur devra la soumettre de nouveau.

Voici les statuts et leurs descriptions respectives :

Utilisez ce point de terminaison pour télécharger le rapport JSON d’une tâche asynchrone ayant le statut COMPLETED (TERMINÉE).

Voici les renseignements d’entrée requis pour cette demande :

• ID de tâche – Spécifiez l’ID de la tâche dont vous souhaitez consulter le statut.

Note :

• L’ID de tâche est une donnée obligatoire pour ce point de terminaison.
• Vous pouvez télécharger le rapport d’une seule tâche asynchrone à la fois.
• Si la tâche n’est pas COMPLETED (TERMINÉE) et que vous tentez de télécharger le rapport, un message d’erreur s’affichera.

La réponse positive à cette requête vous fournira le rapport de la tâche au format JSON.

• Un maximum de 1 000 numéros de suivi d’expédition peut être associé à un projet de visibilité intégrée avancée par requête.
• Il n’y a aucune limite quant au nombre total de numéros de suivi que vous pouvez associer à un projet de visibilité intégrée avancée donné.
• Tout numéro de suivi associé sera dissocié du projet Visibilité intégrée avancée au bout de 40 jours.
• Le statut et les détails de toute tâche créée ne seront plus disponibles après 90 jours pour un projet de visibilité intégrée avancée donné.
• Les informations de suivi sécurisées, telles que l’adresse du destinataire ou sa signature, ne seront pas accessibles via l’abonnement aux numéros de suivi — Visibilité intégrée avancée.