Configuration du webhook Advanced Integrated Visibility
Overview
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. Vous pouvez créer un projet de webhook pour accéder à cette fonctionnalité via le FedEx Developer Portal.
Chemins de navigation
Vous pouvez accéder à la page de création de webhook de deux manières :
- Via Mes projets : Panneau de navigation de gauche → Onglet Webhooks → +CRÉER UN PROJET DE WEBHOOK
Via le catalogue d’API :
- Panneau de navigation de gauche → Catalogue d’API
- Recherchez ou filtrez par projet Advanced Integrated Visibility
- Aperçu -> Cliquez sur Documentation-> Dans la console Sandbox, cliquez sur +CRÉER UN PROJET
- Documents → Cliquez sur +CRÉER UN WEBHOOK
Étapes de création d’un webhook
Étape 1 : sélectionnez le type d’entreprise
Cliquez sur + CRÉER UN PROJET et choisissez votre type d’entreprise dans le menu déroulant :
- Expédie avec FedEx et doit intégrer le webhook FedEx à son système.
- Vend ou propose une solution logicielle qui exploite des données FedEx, et n’est pas un fournisseur FedEx Compatible certifié.
- Est un Fournisseur FedEx Compatible certifié.
Remarque : la solution de webhook FedEx Advanced Integrated Visibility est actuellement indisponible pour cette option. En tant que membre du programme FedEx Compatible, si vous souhaitez accéder à Basic Integrated Visibility ou à d’autres solutions d’intégration FedEx, veuillez contacter votre responsable de canal. Si vous ne savez pas qui est votre responsable de canal, veuillez contacter l’administrateur de votre entreprise.
Sélectionnez ensuite Abonnement aux numéros de compte Advanced Integrated Visibility comme type d’abonnement.
Création d’un abonnement aux numéros de compte Advanced Integrated Visibility
Ce processus comprend quatre étapes principales :
- Configurer le projet
- Saisie des détails du projet
- Choix des comptes d’expédition
- Confirmation des détails et acceptation des conditions
Étape 1 : configurez le projet
Sur la page Configurer le webhook :
- Numéro de compte de facturation :
- Vérifiez le compte de facturation par défaut.
- Pour le modifier :
- Cliquez sur AJOUTER UN COMPTE DE FACTURATION À VOTRE ORGANISATION (s’il n’existe qu’un seul compte), ou
- Cliquez sur SÉLECTIONNER UN AUTRE COMPTE DE FACTURATION (s’il existe plusieurs comptes).
Remarque : Un compte de facturation basé aux États-Unis est requis. Pour plus d’informations sur les tarifs, consultez le guide de tarification de la solution Advanced Integrated Visibility.
Sélection des fonctionnalités :
- Choisissez les fonctionnalités que vous souhaitez activer, puis cliquez sur Suivant.
Description des fonctionnalités
| Nom du champ | Description |
|---|---|
| Preuve de livraison | Confirme la bonne réception d’un envoi. Preuve de livraison par photo (PPODA) : fournit une photo indiquant le lieu exact de la livraison. Preuve de livraison avec signature (SPOD) : fournit une image de la signature du destinataire, du nom de ce dernier ainsi que de la date, de l’heure et du lieu de livraison. |
| Livraison estimée | Aide les destinataires à planifier leur livraison en leur fournissant les éléments suivants : Date de livraison estimée (EDD) Créneau de livraison estimée (EDTW) |
| Événements de suivi | Permet de sélectionner une ou plusieurs catégories d’événements pour recevoir des notifications : Expédition En transit Livraison Exceptions Options de livraison personnalisées |
| Filtrage basé sur les événements | Filtre les réponses des webhooks pour inclure les éléments suivants : Envois entrants Envois sortants Envois tiers |
Sur la page Indiquer les détails, veuillez fournir les informations suivantes :
| 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 : Doit être valide et fonctionnel Doit respecter un format syntaxique standardisé Ne doit pas inclure fedex.com ni ses sous-domaines Peut être réutilisé pour plusieurs webhooks Consultez la section Règles commerciales et bonnes pratiques pour plus d’informations. |
| Jeton de sécurité | Un secret partagé utilisé pour authentifier et valider les réponses des webhooks via HMAC. Exigences : 26 à 100 caractères Doit contenir au moins une majuscule, une minuscule et un chiffre Peut être réutilisé pour plusieurs webhooks |
| 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 : Suivi détaillé – Historique complet des événements Suivi spécifique à un événement – Uniquement l’événement le plus récent |
| 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). |
Étape 3 : choisissez les comptes d’expédition
Sur la page Choisir des comptes d’expédition :
- Sélectionnez un ou plusieurs numéros de compte FedEx à associer à votre projet de webhook.
Remarques importantes :
- Seuls les comptes pas encore associés à d’autres webhooks seront affichés.
- Vous devez associer au moins un compte pour continuer.
- Vous pouvez ajouter jusqu’à 100 comptes via l’interface utilisateur des webhooks.
- Pour associer plus de 100 comptes, utilisez l’API des webhooks.
Contactez le service d’assistance ou le Service Clients FedEx pour activer l’accès aux API.
Étape 4 : confirmez les détails et créez le webhook
Sur la page Confirmer les informations :
1. Vérifiez toutes les informations que vous avez saisies pour le projet de webhook.
2. Cochez la case qui consiste à accepter les conditions générales.
3. Cliquez sur Créer pour finaliser la configuration du webhook.
Une fois la soumission effectuée, le webhook sera créé avec un ID d’inscription généré par le système et le statut Actif.
Règles de validation
Exigences générales :
- Le nom du webhook doit être unique.
- L’URL de destination doit respecter un format syntaxique standardisé (HTTPS sécurisé, sans fedex.com ni ses sous-domaines).
- Tous les champs obligatoires doivent être remplis, sans exception.
- Au moins un numéro de compte FedEx valide doit être associé au webhook.
Validation réussie
Si le webhook est créé avec succès, le client recevra le message de confirmation suivant :
<<Nom du projet de webhook>> créé avec succès. La prise en compte des modifications peut prendre jusqu’à 10 minutes.
Validation non réussie ou ayant échoué
Si FedEx reçoit une réponse autre que HTTP 200 (OK) ou 202 (Accepté) de l’URL de destination, la validation du webhook sera considérée comme un échec.
