Survol
Le Webhook de visibilité intégrée avancée permet à FedEx de transmettre, en quasi temps réel, des données d’événements de suivi sécurisées vers une URL de destination spécifiée 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é par le FedEx Developer Portal.
Chemins de navigation
Vous pouvez accéder à la page de création du webhook par l’une des méthodes suivantes :
- Par Mes projets : Panneau de navigation de gauche → Onglet Webhooks → +CRÉER UN PROJET DE WEBHOOK
- Par le catalogue d’API :
- Panneau de navigation à gauche → catalogue d’API
- Recherchez ou filtrez par Visibilité intégrée avancée
- Aperçu → Cliquez sur Documentation → Dans la console du bac à sable, cliquez sur +CRÉER UN PROJET
- Docs → Cliquez sur +CRÉER un webhook
Étapes de création du webhook
Étape 1 : sélectionner le type d’entreprise
Cliquez sur +CRÉER UN PROJET et choisissez votre type d’entreprise dans la liste déroulante :
- Expédie avec FedEx et doit intégrer le webhook FedEx dans son système.
- Vend ou fournit une solution logicielle qui utilise les données de FedEx et qui n’est pas un fournisseur Compatible FedEx certifié.
- Est un fournisseur Compatible FedEx certifié.
Remarque : actuellement, la solution de webhook de visibilité intégrée avancée de FedEx n’est pas disponible pour cette option. En tant que membre du programme FedEx Compatible, si vous souhaitez accéder à la visibilité intégrée de base ou à d’autres solutions d’intégration FedEx, veuillez communiquer avec votre gestionnaire de canal. Si vous ne savez pas qui est votre gestionnaire de canaux, contactez l‘administrateur de votre entreprise.
Ensuite, sélectionnez Abonnement au numéro de compte de visibilité avancée intégrée comme type d’abonnement.
Création d’un abonnement à la visibilité intégrée avancée par numéro de compte
Le processus de création comprend quatre étapes clés :
Étape 1 : Activation de l’abonnement au numéro de compte de visibilité intégrée avancée
Cette étape est gérée par un administrateur FedEx ou un représentant FedEx à la demande des clients tiers.
- Document MNDA : l’ administrateur de FedEx ou le représentant FedEx recueillera l’ accord mutuel de non-divulgation (Mutual Non-Disclosure Agreement - MNDA) ainsi qu’une liste globale des numéros de compte de la première partie ou de l’expéditeur.
Remarque : les numéros de compte en double associés à d’autres organisations sont autorisés lors de ce téléversement.
- Le cas échéant, la tarification douanière sera activée au niveau de l’organisation.
Remarque : cette fonctionnalité n’est pas incluse dans l’expérience de juillet.
Étape 2 : + créer un projet
Sur la page Sélectionner le(s) produit(s) :
- Cliquez sur Visibilité intégrée avancée – Numéro de compte puis cliquez sur Suivant.
- Sélectionnez les comptes de facturation, acceptez les conditions de paiement, et cliquez sur Suivant.
Au moins un compte de facturation doit être ajouté.
Sur la page Confirmer les détails :
- Vérifier les renseignements du projet.
- Acceptez les modalités.
- Si la tarification douanière s’applique, le document correspondant s’affiche automatiquement.
Une fois la création réussie, le message de confirmation suivant s’affichera :
« Vous avez ajouté le produit avec succès à « Mon projet » ».
Étape 3 : Aperçu du projet – Processus d’activation de la clé API
- Sur la page Aperçu du projet, sous l’onglet Clés API dans la section API, le statut de production de l’abonnement s’affichera initialement comme « Désactivé ».
- Un administrateur ou un représentant de FedEx activera le produit sur demande.
- Une fois activée, l’onglet Clé de production deviendra accessible et le statut de production sera mis à jour à « En attente de confirmation ».
- Après l’activation finale par l’administrateur FedEx ou le représentant, le statut de production sera affiché comme « Activé ».
Étape 4 : aperçu du projet – configurer le webhook
- Accédez à la page Aperçu du projet.
- Sélectionnez l’onglet Webhooks.
- Cliquez sur le bouton + Configurer les webhooks pour commencer la configuration du webhook. Vous serez redirigé vers l’onglet Webhooks.
Descriptions des caractéristiques
| Nom de champ | Description |
|---|---|
| Preuve de livraison | Confirme qu’un envoi a été livré avec succès. Comprend : Preuve de livraison avec image (PPOD) : fournit une photo montrant l’emplacement exact de la livraison. Preuve de livraison avec signature (SPOD) : Fournit une image de la signature du destinataire, de son nom, ainsi que de la date, de l’heure et du lieu de livraison. |
| Livraison prévue | Aide les destinataires à planifier en fournissant : Date de livraison prévue (EDD) À la page de livraison prévue (EDTW) |
| Événements de suivi | Permet de sélectionner une ou plusieurs catégories d’événements pour recevoir des notifications : Expédier En transit Exceptions de livraison Options de livraison de la douane |
| Filtrage par événement | Filtrez les réponses des webhooks pour inclure : Envois entrants Envois sortants Envois par des tiers |
2. Sur la page « Saisir les détails », fournissez les renseignements suivants :
| 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 : Doit être valide et fonctionnel Doit respecter une syntaxe normalisée Ne doit pas inclure fedex.com ni ses sous-domaines Peut être réutilisé pour plusieurs webhooks Consultez la section Règles opérationnelles et pratiques exemplaires pour plus de détails. |
| Jeton de sécurité | Un secret partagé utilisé pour authentifier et valider les réponses du webhook par HMAC. Exigences : 26 à 100 caractères Doit inclure au moins 1 caractère majuscule, 1 minuscule et 1 caractère numérique Peut être réutilisé pour plusieurs webhooks |
| 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 : Suivi détaillé - Historique complet de l’événement Suivi spécifique à un événement - uniquement l’événement le plus récent |
| 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 :seules les locales des États-Unis sont prises en charge (p. ex., en-US, es-US). |
Étape 3 : choisir les comptes d’expédition
Sur la page Choisir les comptes d’expédition :
Sélectionnez un ou plusieurs numéros de compte FedEx à associer à votre projet de webhook.
Remarques importantes :
Seuls les comptes qui ne sont pas déjà associés à d’autres webhooks seront affichés.
Vous devez associer au moins un compte pour continuer.
Un maximum de 100 comptes peut être ajouté par l’interface utilisateur du webhook.
Pour associer plus de 100 comptes, utilisez l’API des webhooks.
Veuillez communiquer avec le soutien à la clientèle de FedEx ou le centre d’assistance pour demander l’accès à l’API.
Étape 4 : confirmer les détails et créer
Sur la page Confirmer les détails :
1. Passez en revue tous les renseignements que vous avez saisies pour le projet webhook.
2. Cochez la case pour accepter les Modalités.
3. Cliquez sur Créer pour finaliser la configuration du webhook.
Après une soumission réussie, le webhook sera créé avec un identifiant d’abonnement généré par le système et sera défini comme étant à l’état 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é, pas de fedex.com ou ses sous-domaines).
Tous les champs requis doivent être remplis—aucun champ obligatoire ne doit être laissé vide.
Au moins un numéro de compte d’expédition FedEx valide doit être associé au webhook.
Validation réussie :
Si le webhook est créé avec succès, le client recevra un message de confirmation :
<<Nom du webhook>> créé avec succès. Les modifications peuvent prendre jusqu’à 10 minutes avant d’entrer en vigueur.
Validation infructueuse/échouée :
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 ayant échoué.
