Fedex Logo

CRÉER UN
WEBHOOK GÉRER LES WEBHOOKS

Comment fonctionne la visibilité intégrée avancée

Le webhook de visibilité intégrée avancée permet à FedEx d’envoyer des mises à jour de suivi sécurisées, quasi en temps réel, à une URL précise. 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 de visibilité intégrée avancée.

Comment accéder à la page de visibilité intégrée avancée

Vous pouvez accéder à la configuration de la visibilité intégrée avancée de deux façons :

Option 1 : par 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 : par le catalogue d’API

    1. Ouvrez le catalogue d’API à partir du panneau de navigation de gauche.

    2. Recherchez Visibilité intégrée avancée.

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

    4. Sur la carte :

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

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

    2. Vend ou fournit une solution logicielle qui utilise les données de FedEx et qui n’est pas un fournisseur compatible FedEx certifié.

    3. Est un fournisseur compatible FedEx certifié.

 

Ensuite, sélectionnez Abonnement de visibilité intégrée avancée par numéro de suivi comme type d’abonnement.

Créer un abonnement de visibilité intégrée avancée par numéro de suivi

Vous pouvez configurer un abonnement de visibilité intégrée avancée par numéro de suivi pour recevoir des mises à jour de suivi sécurisées, quasi en temps réel, pour un ou plusieurs numéros de suivi FedEx. Ces mises à jour sont envoyées à une URL de destination que vous spécifiez.

 

Étapes de création de l’abonnement

Ce 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 des numéros de suivi

 

Instructions étape par étape

    1. Sur la page Configurer le webhook :

         Vérifier le numéro de compte de facturation

         Le numéro de compte de facturation par défaut de votre organisation sera affiché.

         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 de détails sur les prix, consultez la page Aperçu de la visibilité intégrée avancée .

 

2. Sélectionner 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 (?) à côté de celle-ci.

Descriptions des caractéristiques

Nom de champ Description
Preuve de livraison Confirme qu’un envoi a été livré avec succès. Cela comprend :
  • Preuve de livraison avec image (PPODA) : Fournit une photo montrant le lieu exact de 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 bénéficiaires à planifier en leur fournissant :
  • Date de livraison prévue (EDD)
  • Plage 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
  • Avis
  • Exceptions

 

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 des événements
  • Suivi spécifique à l’é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 : seuls les paramètres de lieu des États-Unis sont pris en charge (p. ex., en-US, es-US).

3. Sur la page Confirmer les détails :

  •  Passez en revue les détails de votre projet de webhook.
  •  Vérifiez et acceptez les modalités.
  •  Cliquez sur Créer pour finaliser la configuration du projet de webhook.

4. Une fois votre demande soumise avec succès :

  •  FedEx créera un nouveau projet de webhook.
  •  Vous recevrez des clés de production pour l’API d’abonnement de visibilité intégrée avancée par numéro de suivi.
  •  Vous pouvez utiliser cette API pour associer des numéros de suivi à votre projet.

Pour en savoir plus, consultez la page de la documentation de l’API d’abonnement de visibilité intégrée avancée par numéro de suivi.

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 de visibilité intégrée avancée par numéro de suivi, suivez les étapes suivantes :

 

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

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

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

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

Response

Copy