Pour ajouter un numéro de suivi à votre abonnement Webhook à l’aide de l’API d’abonnement à la visibilité intégrée avancée par numéro de suivi, suivez les étapes ci-dessous :

1. Créez un projet d’abonnement à la visibilité intégrée avancée par numéro de suivi en suivant les étapes de la section précédente ou celles fournies dans le guide de démarrage.
2. Vous avez besoin d’un jeton OAuth pour lancer des appels à l’API d’abonnement à la visibilité intégrée avancée par numéro de suivi. Pour générer ce jeton, utilisez l’API d’autorisation. Consultez la documentation de l’API d’autorisation dans le catalogue d’API pour connaître les étapes détaillées de génération d’un jeton OAUTH.
3. Cliquez sur Détails du projet dans le menu de navigation de gauche. Sous l’onglet Clés de production, faites défiler la page pour trouver la documentation de l’API d’abonnement à la visibilité intégrée avancée par numéro de suivi.

Une fois que vous accédez à la documentation de l’API d’abonnement à la visibilité intégrée avancée par numéro de suivi, vous trouverez trois points de terminaison :

Point de terminaison d’association du numéro de suivi

• Utilisez ce point pour ajouter ou retirer des numéros de suivi d’un abonnement Webhook. Vous trouverez plus de détails dans la documentation de l’API d’abonnement à la visibilité intégrée avancée par numéro de suivi.
• Toute action d’ajout ou de retrait de numéros de suivi est traitée de façon asynchrone. Un ID de tâche (job ID) est envoyé en réponse à l’appel de l’API d’ajout ou de suppression d’association de numéro de suivi.

Point de terminaison des détails de la tâche de numéro de suivi

Ce point de terminaison fournit les détails d’un Job ID, comme le nombre de numéros de suivi soumis qui ont été ajoutés avec succès à l’abonnement Webhook concernée, ou encore combien sont toujours en cours de traitement.

Point de terminaison du statut de la tâche de numéro de suivi

Ce point fournit un résumé en temps réel de toutes les tâches en cours de traitement.

1. Utilisez le jeton AUTH généré à l’étape 2 avec le point de terminaison d’association du numéro de suivi pour ajouter des numéros de suivi à votre souscription Webhook.

Règles de validation :

• Le nom du webhook doit être unique.
• L’URL de destination du webhook doit être au format syntaxique normalisé.
• Aucun des champs requis pour créer un webhook ne doit être vide.
• Au moins un numéro de compte d’envoi FedEx disponible doit être associé pour créer un webhook.
• Pour une validation réussie :
  • Lorsqu’un webhook est créé avec succès, le client reçoit un message de confirmation.

    Exemple de message de confirmation : <<Webhook name>> créé avec succès. Les modifications peuvent prendre jusqu’à 10 minutes avant d’entrer en vigueur.

• Pour une validation n’ayant pas réussi/ayant échoué :
  • Si FedEx reçoit une réponse autre que 200 (OK) ou 202 (Accepté), la validation de l’URL de destination du webhook est considérée comme ayant échoué.