Comment fonctionne Advanced Integrated Visibility
Aperçu du webhook Advanced Integrated Visibility
Le webhook Advanced Integrated Visibility permet à FedEx d’envoyer en temps quasi réel des données de suivi sécurisées à une URL de destination spécifique pour les envois associés à un ou plusieurs numéros de compte FedEx.
Pour utiliser cette fonctionnalité, un administrateur FedEx ou un administrateur DI doit créer un projet de webhook Advanced Integrated Visibility.
Options de navigation
Vous pouvez accéder à la page Webhooks Advanced Integrated Visibility de deux manières :
Option 1 : via Mes projets
- Accédez à Mes projets dans le panneau de navigation de gauche.
- Cliquez sur l’onglet Webhooks.
Option 2 : via le catalogue d’API
- Accédez au catalogue d’API dans le panneau de navigation de gauche.
- Cherchez Advanced Integrated Visibility dans la barre de recherche, ou sélectionnez-le dans la section FILTRES.
- Sur la carte Webhook, choisissez l’une des options suivantes :
- Cliquez sur Documents → + Gérer les webhooks
Affichage d’un projet d’abonnement aux numéros de suivi Advanced Integrated Visibility
1. Accès et configuration FedEx
- Un administrateur ou un représentant commercial FedEx lancera le processus de configuration.
- Le profil de l’organisation est créé par un administrateur désigné pour le compte des clients CSP.
- Un numéro de compte de facturation américain valide est ajouté au niveau de l’organisation par l’administrateur au nom du client.
- L’administrateur effectuant cette configuration doit disposer des autorisations nécessaires pour gérer les configurations au niveau de l’organisation.
2. Afficher le flux de travail pour l’abonnement aux numéros de suivi
2.1 Afficher l’abonnement
- Une fois qu’un administrateur ou un représentant commercial FedEx crée un projet, les utilisateurs peuvent voir le projet d’abonnement aux numéros de suivi Advanced Integrated Visibility directement dans leur tableau de bord.
2. Afficher les fonctionnalités
- Les utilisateurs peuvent explorer les fonctionnalités disponibles associées au projet d’abonnement afin de mieux comprendre et utiliser le service.
Description des fonctionnalités
| Nom du champ | Description |
|---|---|
| Preuve de livraison | Confirme la bonne réception d’un envoi. Inclut les éléments suivants :
|
| Livraison estimée | Aide les destinataires à planifier leur livraison en leur fournissant les éléments suivants :
|
| Événements de suivi | Permet de sélectionner une ou plusieurs catégories d’événements pour recevoir des notifications :
|
Les données suivantes seront affichées sur la page Détails :
| Nom du champ | Description |
|---|---|
| Nom du projet de webhook | Un nom unique pour votre projet de webhook. Un nom est proposé par défaut, mais vous pouvez le modifier. Il ne doit pas être utilisé par un autre webhook. |
| URL de destination | Le point de terminaison HTTPS sécurisé vers lequel FedEx enverra les données de suivi. Exigences :
|
| Jeton de sécurité | Un secret partagé utilisé pour authentifier et valider les réponses des webhooks via HMAC. Exigences :
|
| Langue de la charge utile (pays) | Sélectionnez la langue de traduction des données de suivi dans la liste déroulante. |
| Type de suivi | Choisissez le mode de réception des données de suivi :
|
| Adresse électronique | Fournissez une adresse e-mail valide pour recevoir les notifications. |
| Langue des e-mails (pays) | Sélectionnez la langue souhaitée pour les notifications par e-mail. Remarque : seules les variantes de langue américaines sont prises en charge (par exemple : en-US, es-US). |
Processus étape par étape
4. Créer un projet d’abonnement
- Suivez les étapes de la section précédente ou consultez le guide de démarrage.
5. Générer un jeton OAuth
- Un jeton OAuth est nécessaire pour effectuer des appels d’API.
- Utilisez l’API d’autorisation pour le générer.
- Consultez la documentation sur l’API d’autorisation dans le catalogue d’API pour obtenir des instructions détaillées.
6. Accéder à la documentation sur l’API
- Dans le menu de navigation de gauche, cliquez sur Détails du projet.
- Sous l’onglet Clés de production, faites défiler la page pour trouver la documentation relative à l’API d’abonnement aux numéros de suivi Advanced Integrated Visibility.
Présentation des points de terminaison de l’API
| Point de terminaison | Objectif |
|---|---|
| Association de numéros de suivi | Permet d’ajouter ou de supprimer des numéros de suivi d’un abonnement webhook. Il s’agit d’une tâche asynchrone. Un ID de tâche est renvoyé dans la réponse. |
| Détails de tâche du numéro de suivi | Fournit des détails pour un identifiant de tâche spécifique, tels que le nombre de numéros de suivi ajoutés avec succès ou en cours de traitement. |
| Statut de tâche du numéro de suivi | Renvoie un résumé de toutes les tâches en cours de traitement. |
Utilisez le jeton OAuth de l’étape 2 avec le point de terminaison Association de numéros de suivi pour ajouter des numéros de suivi à votre webhook.
Règles de validation
- Les noms de webhook doivent être uniques.
- L’URL de destination doit respecter le format syntaxique standard.
- Tous les champs obligatoires doivent être remplis.
- Au moins un numéro de compte d’expédition FedEx valide doit être associé.
Résultats de la validation
| Statut | Détails |
|---|---|
| Réussite | Un message de confirmation s’affiche : « <> créé avec succès. La prise en compte des modifications peut prendre jusqu’à 10 minutes. » |
| Échec | 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é. |
