Comment fonctionne la visibilité intégrée avancée
Aperçu du webhook de visibilité intégrée avancée
Le Webhook de visibilité intégrée avancée permet à FedEx de transmettre de manière sécurisée des données d’événements de suivi en temps quasi réel vers une URL de destination spécifiée pour les envois liés à un ou plusieurs numéros de compte FedEx désignés.
Pour utiliser cette fonctionnalité, un administrateur FedEx ou un administrateur DI doit créer un projet de webhook de visibilité intégrée avancée.
Options de navigation
Vous pouvez accéder à la page Webhooks de visibilité intégrée avancée de deux façons :
Option 1 : par « Mes projets »
- Accédez à « Mes projets » à partir du panneau de navigation de gauche.
- Cliquez sur l’onglet « Webhooks ».
Option 2 : par le catalogue d’API
- Accédez au catalogue d’API à partir du panneau de navigation de gauche.
- Utilisez la barre de recherche pour trouver Visibilité intégrée avancée ou sélectionnez-la dans la section FILTRES .
- Sur la carte Webhook, choisissez l’une des options suivantes :
- Cliquez sur Docs → puis sur + Gérer les webhooks
Consulter un projet d’abonnement au numéro de suivi de visibilité intégrée avancée
1. Accès personnel FedEx et configuration
- Un administrateur FedEx ou un représentant FedEx initiera le processus d’installation.
- Le profil de l’organisation est créé par un administrateur désigné au nom des clients CSP.
- Un numéro de compte de facturation admissible basé aux États-Unis est ajouté au niveau de l’organisation par l’administrateur au nom du client.
- L’administrateur qui effectue cette configuration doit disposer des autorisations appropriées pour gérer les configurations au niveau de l’organisation.
2. Afficher le flux de travail de l’abonnement par numéro de suivi
2.1 Voir l’abonnement
- Une fois qu’un administrateur ou un représentant FedEx a créé un projet, les utilisateurs peuvent consulter le projet de visibilité intégrée avancée – Abonnement au numéro de suivi dans leur tableau de bord.
2. Afficher les fonctionnalités
- Les utilisateurs peuvent explorer les fonctionnalités disponibles associées au projet d’abonnement pour une meilleure compréhension et utilisation.
Descriptions des fonctionnalités
| Nom de champ | Description |
|---|---|
| Preuve de livraison | Confirme qu’un envoi a été livré avec succès. Cela comprend :
|
| Livraison prévue | Aide les bénéficiaires à planifier en leur fournissant :
|
| Événements de suivi | Permet de sélectionner une ou plusieurs catégories d’événements pour recevoir des notifications :
|
Sur la page « Détails », les renseignements suivants seront affichés :
| Nom de champ | Description |
|---|---|
| Nom du projet de webhook | Un nom unique et non vide pour votre projet de webhook. Un nom suggéré est automatiquement rempli, mais peut être modifié. Ce nom ne doit pas être utilisé dans un autre webhook. |
| URL de destination | Le point de terminaison HTTPS sécurisé où FedEx enverra les données des événements de suivi. Exigences :
|
| Jeton de sécurité | Un secret partagé utilisé pour authentifier et valider les réponses du webhook par HMAC. Exigences :
|
| Langue (pays) des données utiles | Sélectionnez la langue préférée pour la traduction des données de suivi dans la liste déroulante. |
| Type de suivi | Choisissez comment les données de suivi doivent être transmises :
|
| Adresse courriel | Fournissez une adresse courriel valide pour recevoir des notifications. |
| Langue du courriel (Pays) | Sélectionnez la langue préférée pour les notifications par courriel. Remarque : seuls les paramètres de lieu des États-Unis sont pris en charge (p. ex., 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
- Vous avez besoin d’un jeton OAuth pour effectuer des appels à l’API.
- Utilisez l’ API d’autorisation pour générer le jeton.
- Consultez la documentation de l’API d’autorisation dans le catalogue d’API pour les étapes détaillées.
6. Accéder à la documentation de 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 pour trouver la documentation de l’API d’abonnement de visibilité intégrée avancée par numéro de suivi.
Aperçu des points de terminaison API
| Point de terminaison | But |
|---|---|
| Association de numéros de suivi | Ajouter ou supprimer des numéros de suivi d’un abonnement webhook. Il s’agit d’une tâche asynchrone. Un identifiant de tâche est renvoyé dans la réponse. |
| Détails de la tâche du numéro de suivi | Fournit des détails pour un identifiant de tâche spécifique (Job ID), tels que le nombre de numéros de suivi qui ont été ajoutés avec succès ou qui sont toujours en cours de traitement. |
| Statut de la tâche du numéro de suivi | Retourne 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 un format syntaxique normalisé.
- Tous les champs requis 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éussie | Un message de confirmation s’affiche : « <> créé avec succès. Les modifications peuvent prendre jusqu’à 10 minutes avant d’entrer en vigueur. » |
| É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é. |
