Introduction
L’abonnement aux numéros de suivi Advanced Integrated Visibility permet aux abonnés Advanced Integrated Visibility de gérer leurs projets de webhook basés sur le numéro de suivi et d’effectuer des opérations liées auxdits projets : ajouter de nouveaux numéros de suivi, apporter des modifications ou afficher les détails d’une tâche à l’aide des points de terminaison de l’API.
Remarque :
- Vous devez disposer d’un accès administrateur ou contributeur pour votre projet Advanced Integrated Visibility.
- Pour plus d’informations sur Advanced Integrated Visibility et ses fonctionnalités, consultez la page Documentation Advanced Integrated Visibility.
Avantages de l’abonnement aux numéros de suivi Advanced Integrated Visibility
L’abonnement aux numéros de suivi Advanced Integrated Visibility revêt plusieurs avantages :
- Vous pouvez facilement mettre à jour et gérer les numéros de suivi de votre projet Advanced Integrated Visibility à l’aide des 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 d’associer chaque numéro de suivi un par un.
- Vous pouvez soumettre des requêtes API consécutives et consulter le journal de réussite/d’échec de ces requêtes.
Fonctionnement de l’abonnement aux numéros de suivi Advanced Integrated Visibility
Utilisez les points de terminaison ci-dessous pour gérer votre projet Advanced Integrated Visibility :
Cette API est accessible uniquement via l’aperçu de votre projet, comme illustré dans la capture d’écran ci-dessus.
Association de numéros de suivi
Utilisez ce point de terminaison pour déclencher une tâche asynchrone afin d’associer un ou plusieurs numéros de suivi à un projet Advanced Integrated Visibility spécifique.
Voici les informations de saisie requises pour cette requête :
- 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 à une seule requête. Une réponse positive à cette requête renverra l’ID de la tâche, le statut de cette dernière ainsi que l’horodatage de sa création et de sa fin. L’ID de tâche pourra être utilisé ultérieurement pour vérifier le statut de la tâche asynchrone.
Statut de tâche du numéro de suivi
Utilisez ce point de terminaison pour obtenir le statut d’une tâche asynchrone (une ou plusieurs requêtes consécutives dans la file d’attente) ou le statut de toutes les tâches soumises.
Voici les informations de saisie requises pour cette requête :
- ID de tâche : spécifiez l’ID de tâche pour lequel vous souhaitez récupérer le statut.
Remarque : l’ID de tâche est une entrée facultative pour ce point de terminaison. Si vous ne le spécifiez pas, vous obtiendrez le statut de toutes les tâches soumises.
Une réponse positive à cette requête renverra l’ID de la tâche, le statut de cette dernière ainsi que l’horodatage de sa création et de sa fin. Elle indiquera également le statut actuel des tâches, mais aussi les messages de réussite, les avertissements ou les erreurs que les utilisateurs peuvent corriger, le cas échéant.
- Si le statut de la tâche indique « TERMINÉ », cela signifie que tous les numéros de suivi ont été validés et traités.
- Le statut « TERMINÉ » indique que les numéros de suivi ont été validés et traités. Cela ne veut pas pour autant dire que tous les numéros de suivi ont été ajoutés au projet Advanced Integrated Visibility.
- Si vous tentez d’associer plusieurs numéros de suivi et que l’association échoue pour une partie d’entre eux, la tâche passera au statut « TERMINÉ ». Pour confirmer le statut de chaque numéro de suivi dans la demande d’association, vous devez télécharger le rapport du lot.
- Si le statut de la tâche indique « ÉCHEC », la demande n’a pas pu être traitée pour des raisons diverses, ou une erreur s’est produite. L’utilisateur doit réessayer.
Remarque :
Voici les statuts et leurs descriptions respectives :
| STATUT DE LA TÂCHE | DESCRIPTION |
|---|---|
SOUMISE |
La tâche est soumise au système après toutes les validations de base. Elle sera traitée de manière asynchrone. |
ACCEPTÉE |
La tâche est acceptée et sera mise en file d’attente. |
NON ACCEPTÉE |
La tâche n’est pas acceptée en raison d’une défaillance interne ou d’une indisponibilité du système. L’utilisateur doit réessayer. |
AJOUTÉE À LA FILE D’ATTENTE |
La tâche est en file d’attente et le traitement peut démarrer à tout moment. |
EN COURS |
La tâche a été démarrée et est en cours. |
TERMINÉ |
La tâche est terminée, et le rapport d’importation ou le fichier d’exportation est disponible au téléchargement. |
ÉCHEC |
La tâche a échoué pour diverses raisons et doit être relancée par l’utilisateur. |
Détails de tâche du numéro de suivi
Utilisez ce point de terminaison pour télécharger le rapport JSON d’une tâche asynchrone dont le statut indique « TERMINÉ ».
Voici les informations de saisie requises pour cette requête :
- ID de tâche : spécifiez l’ID de tâche pour lequel vous souhaitez récupérer le statut.
Remarque :
- L’ID de tâche est une entrée obligatoire pour ce point de terminaison.
- Vous ne pouvez télécharger le rapport que d’une seule tâche asynchrone à la fois.
- Si la tâche n’a pas le statut « TERMINÉ » et que vous essayez de télécharger le rapport, un message d’erreur s’affiche.
Une réponse sans erreur à cette demande renverra le rapport de la tâche au format JSON.
Règles commerciales
- Vous ne pouvez pas associer plus de 1 000 numéros de suivi d’expédition à un projet Advanced Integrated Visibility par requête.
- Il n’y a aucune limite quant au nombre de numéros de suivi que vous pouvez associer à un projet Advanced Integrated Visibility.
- Tout numéro de suivi associé à un projet Advanced Integrated Visibility sera dissocié au bout de 40 jours.
- Vous perdrez l’accès au statut et aux détails d’un ID de tâche d’un projet Advanced Integrated Visibility au bout de 90 jours.
- Les informations de suivi sécurisées telles que l’adresse et la signature du destinataire ne seront pas disponibles via l’abonnement aux numéros de suivi Advanced Integrated Visibility.
Response