Fedex Logo

CRÉER UN
WEBHOOK GÉRER DES WEBHOOKS

Fonctionnement d’Advanced Integrated Visibility

Le webhook Advanced Integrated Visibility permet à FedEx d’envoyer des mises à jour de suivi sécurisées et quasi instantanées à une URL spécifique. Ces mises à jour concernent les envois liés à un ou plusieurs numéros de compte FedEx. Pour utiliser cette fonctionnalité, vous devez créer un projet de webhook Advanced Integrated Visibility.

Comment accéder à la page Advanced Integrated Visibility

Vous pouvez accéder à la configuration du projet Advanced Integrated Visibility de deux manières :

Option 1 : via Mes projets

    1. Accédez à Mes projets dans le panneau de navigation de gauche.

    2. Cliquez sur l’onglet Webhooks.

    3. Sélectionnez + CRÉER UN PROJET DE WEBHOOK.

Option 2 : via le catalogue d’API

    1. Ouvrez le Catalogue d’API depuis le panneau de navigation de gauche.

    2. Recherchez Advanced Integrated Visibility.

    3. Utilisez le filtre WEBHOOK pour trouver la carte correspondante.

    4. Sur la carte :

  •  Cliquez sur Aperçu, puis sur le bouton Documentation et choisissez + CRÉER UN PROJET DE WEBHOOK.
  •  Ou accédez à DOCUMENTS et cliquez sur + CRÉER UN PROJET DE 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 :

    1. Expédie avec FedEx et doit intégrer le webhook FedEx à son système.

    2. Vend ou propose une solution logicielle qui exploite des données FedEx, et n’est pas un fournisseur FedEx Compatible certifié.

    3. Est un fournisseur FedEx Compatible.

 

Sélectionnez ensuite Abonnement aux numéros de suivi Advanced Integrated Visibility comme type d’abonnement.

Créer un abonnement aux numéros de suivi Advanced Integrated Visibility

Vous pouvez configurer un abonnement aux numéros de suivi Advanced Integrated Visibility pour recevoir des mises à jour de suivi sécurisées et quasi en temps réel pour un ou plusieurs numéros de suivi FedEx. Ces mises à jour sont envoyées à l’URL de destination que vous spécifiez.

 

Étapes de création de l’abonnement

Le processus comprend quatre étapes principales :

    1. Configurer le projet

    2. Saisir les détails du projet

    3. Confirmer les détails et accepter les conditions

    4. Ajouter les numéros de suivi

 

Instructions étape par étape

    1. Sur la page de configuration du webhook :

         Vérifiez le numéro de compte de facturation

         Le numéro de compte de facturation par défaut de votre organisation s’affiche.

         Pour le modifier :

  •  Cliquez sur AJOUTER UN COMPTE DE FACTURATION À VOTRE ORGANISATION (si vous n’avez qu’un seul compte), ou
  •  Cliquez sur SÉLECTIONNER UN AUTRE COMPTE DE FACTURATION (si vous avez plusieurs comptes).

 

Remarque : pour plus d’informations sur les tarifs, consultez la page Aperçu de FedEx Advanced Integrated Visibility.

 

2. Sélectionnez les fonctionnalités

  •  Choisissez les fonctionnalités dont vous avez besoin.
  •  Cliquez sur Suivant pour continuer.

Conseil : pour en savoir plus sur chaque fonctionnalité, cliquez sur l’icône d’aide (?) située à côté.

Description des fonctionnalités

Nom du champ Description
Preuve de livraison Confirme la bonne réception d’un envoi. Inclut les éléments suivants :
  • 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édier
  • En transit
  • Livraison
  • Exceptions

 

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).

3. Sur la page Confirmer les informations :

  •  Vérifiez les détails de votre projet de webhook.
  •  Consultez et acceptez les conditions générales.
  •  Cliquez sur Créer pour finaliser la configuration du projet de webhook.

4. Une fois votre demande soumise :

  •  FedEx créera un nouveau Projet de webhook.
  •  Vous recevrez les clés de production pour l’API d’abonnement aux numéros de suivi Advanced Integrated Visibility.
  •  Vous pouvez utiliser cette API pour associer des numéros de suivi à votre projet.

Pour en savoir plus, consultez la page de documentation sur l’API d’abonnement aux numéros de suivi Advanced Integrated Visibility.

Comment ajouter un numéro de suivi à un webhook

Pour ajouter un numéro de suivi à votre abonnement webhook à l’aide de l’API d’abonnement aux numéros de suivi Advanced Integrated Visibility, suivez ces étapes : :

 

Processus étape par étape

1. Créer un projet d’abonnement

Suivez les étapes de la section précédente ou consultez le guide de démarrage.

2. 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.

3.. 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

  •  Le nom du webhook doit être unique.
  •  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é.
CLOSE

Response

Copy