Commencer
Le FedEx Developer Portal offre une suite d’interfaces de programmation d’application (API) pour intégrer FedEx à vos applications. Ces instructions vous guideront pour configurer une organisation, créer un projet, tester votre intégration, passer un projet en production et, dans certains cas, valider votre API.
Types d’utilisateurs :
FedEx offre des services d’intégration à trois types d’utilisateurs : les expéditeurs FedEx, les solutions logicielles vérifiées telles que Fournisseur FedEx Compatible et les fournisseurs Intégrateur FedEx.
Expéditeur FedEx :
Entreprise qui expédie avec FedEx et qui doit intégrer des API FedEx dans ses propres applications.
Fournisseur de solution ou de service :
Entreprise qui doit intégrer les API FedEx pour créer une solution, une application ou un plug-in qui peut être vendu et/ou distribué à une organisation externe qui expédie avec FedEx.
- Fournisseur FedEx Compatible : entreprise vérifiée avec un accord contractuel via le programme FedEx Compatible.
- Fournisseur d’intégrateur FedEx : entreprise vérifiée avec un accord contractuel via le programme d’Intégrateur FedEx.
Sélectionnez l’option ci-dessous qui décrit le mieux votre entreprise. Quel que soit votre type d’utilisateur, il existe une expérience pour commencer qui vous convient.
Faites votre choix pour commence.
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
Prérequis
Vous devez posséder un ID d’utilisateur FedEx pour vous connecter au FedEx Developer Portal et créer une organisation.
Si votre entreprise n’a pas d’organisation, créez-en une. Sinon, rejoignez une organisation existante.
Créer une organisation
Dans la barre de navigation, cliquez sur « Créer ou rejoindre une organisation ».
Remarque : en tant que créateur, vous êtes automatiquement désigné comme l’administrateur de l’organisation.
Les administrateurs peuvent :
inviter des utilisateurs ;
attribuer des rôles (par exemple, contributeur, spectateur) et des projets aux utilisateurs ;
gérer les comptes d’expédition.
Pour en savoir plus sur ces rôles, consultez notre guide sur l’administration des organisations.
Pour le type d’entreprise, sélectionnez « Vend ou propose une solution logicielle qui utilise la technologie FedEx et est un fournisseur d’intégrateur FedEx validé ».
Indiquez le nom de votre entreprise, l’URL de votre site Web ainsi qu’un nom d’organisation unique. Le nom de l’organisation peut correspondre à celui de votre entreprise ou représenter un groupe spécifique (service, division, région, localisation). Ces informations sont nécessaires pour valider votre demande.
Remarque : choisissez un nom d’organisation que tous les autres utilisateurs reconnaîtront (par exemple, nom de l’entreprise, service, région, localisation).
Précisez la localisation de votre entreprise et l’endroit où votre solution logicielle sera vendue ou distribuée.
Ajoutez un compte de facturation et authentifiez le compte.
Remarque : en tant que fournisseur de services d’expédition et de logistique dans le programme d’Intégrateur FedEx, vous devez utiliser votre propre numéro de compte. Vous ne pouvez pas utiliser le compte FedEx d’un client.
Saisissez votre numéro de compte FedEx. Si vous n’avez pas de compte FedEx existant, créez-en un sur fedex.com ou contactez un représentant de l’assistance FedEx.
Saisissez le pseudonyme du compte et l’adresse de facturation associée au compte. Sélectionnez « Suivant ».
Remarque : l’adresse de facturation doit correspondre à celle dont nous disposons pour ce compte. Il s’agira du compte de facturation par défaut de votre organisation.
Pour terminer la création de votre organisation, vous devez authentifier votre compte. Choisissez une option d’authentification (téléphone [disponible uniquement pour les intégrateurs aux États-Unis et au Canada], adresse e-mail, SMS) et sélectionnez « Suivant ».
Une fois le code d’authentification reçu, saisissez-le et sélectionnez « Soumettre ».
Accepter les conditions
Lisez le Contrat d’Intégrateur mondial et le Manuel du Programme. Cochez les cases pour confirmer que vous acceptez les conditions, puis sélectionnez « Accepter ».
Un écran de confirmation s’affiche. Cliquez sur « Gérer l’organisation » pour modifier les informations si nécessaire.
Inviter des utilisateurs
Remarque : seuls les administrateurs peuvent inviter des utilisateurs.
Sélectionnez « Gérer l’organisation » dans le menu de navigation de gauche.
Accédez à l’onglet « Utilisateurs » et sélectionnez « Ajouter des utilisateurs ».
Remplissez le formulaire et attribuez le rôle approprié aux nouveaux utilisateurs : spectateur, contributeur ou administrateur.
Pour en savoir plus sur les rôles utilisateur, consultez le guide pour l’administration des organisations.
Affectez les utilisateurs à des projets (si applicable) dans le menu déroulant « Projets ».
Saisissez les adresses e-mail de chaque utilisateur, puis sélectionnez « Inviter ».
Rejoindre une organisation existante
Demandez une invitation : demandez à l’administrateur de votre organisation de vous envoyer une invitation. Vous avez 24 heures pour l’accepter avant son expiration. Si nécessaire, demandez à l’administrateur de la renvoyer.
Acceptez l’invitation : connectez-vous avec votre ID d’utilisateur et votre mot de passe. Si votre ID est déjà lié à une autre organisation, vous devrez en créer un nouveau.
Rejoindre une organisation existante
Étape 1 : demandez à l’administrateur de votre organisation de vous envoyer une invitation.
Si votre entreprise a déjà créé une organisation, demandez à son administrateur de vous inviter à la rejoindre. Vous disposerez de 24 heures pour accepter son invitation. Passé ce délai, vous pourrez toujours lui demander de vous la renvoyer.
Étape 2 : acceptez l’invitation.
Pour accepter l’invitation, vous devez vous connecter à l’aide de votre ID d’utilisateur et de votre mot de passe existants. Si votre ID d’utilisateur existant est déjà associé à une organisation, vous devez en créer un nouveau.
Créer un projet API
Consultez la page Mes projets et ouvrez l’onglet API. Cliquez sur Créer un projet d’API.
Étape 1 : sélectionnez la ou les API que vous souhaitez inclure dans votre projet
Vérifiez les quotas de l’API, les limites de débit et les détails de la validation API.
Étape 2 : configurez les informations du projet
- Attribuez à votre projet un nom identifiable et unique pour votre organisation.
- Sélectionnez les pays dans lesquels vous prévoyez d’expédier des colis, afin que nous puissions vous attribuer un compte d’expédition de test. Pour tester l’expédition de colis au sein d’un pays européen, vous devez disposer d’un compte de test distinct pour chaque pays.Vous pourrez toujours ajouter ou supprimer des pays ultérieurement.
- Pour être informé des dernières mises à jour de l’API et de toute information relative à une interruption, configurez vos préférences de notification.
Étape 3 : lisez et acceptez les conditions, y compris le Contrat de licence du FedEx Developer Portal
Une fois les conditions acceptées, cliquez sur Créer. Une fenêtre de confirmation s’affiche. Vous pouvez alors afficher vos informations d’identification de test dans votre nouveau projet.
Créez un projet webhook
Conditions préalables
- Tarification : les abonnés sont facturés mensuellement en fonction du nombre de numéros de suivi. Consultez le guide de tarification pour en savoir plus sur nos prix.
- Configurer des comptes : le webhook Advanced Integrated Visibility nécessite un compte de facturation basé aux États-Unis et au moins un compte d’expédition, ces deux types de comptes étant mutuellement exclusifs. Seuls les administrateurs peuvent ajouter des comptes sur la page Gérer l’organisation.
Créez une URL (redirection) valide dans votre application ou plateforme de destination
Votre URL de destination sera utilisée pour recevoir les codes et les messages d’authentification, ainsi que les notifications de charge utile de webhook de la part de FedEx. Votre URL doit utiliser le protocole HTTPS pour garantir la sécurité. Votre URL sera bloquée si elle inclut :
- Espace IP RFC1918
- Le domaine fedex.com ou l’un de ses sous-domaines
- Les adresses IP dans l’URL (y compris localhost, 127.0.0.1)
Générer un jeton de sécurité
Ce jeton de sécurité peut être utilisé en tant que clé secrète afin d’authentifier et de valider les informations transmises entre votre organisation et FedEx. Votre jeton de sécurité doit inclure :
- Une longueur comprise entre 26 et 100 caractères
- 1 majuscule
- 1 minuscule
- 1 caractère numérique
Exemple : Y1F6OiVUQW2JPSElmRE9U0IY5
Une fois votre URL et votre jeton de sécurité définis, vous pouvez créer un projet de webhook. Consultez la page Mes projets et ouvrez l’onglet Webhooks. Cliquez sur Créer un projet de webhook.
Sélectionner le type d’inscription
Les expéditeurs FedEx peuvent inscrire leurs événements aux numéros de compte ou de suivi.
Étape 1 : confirmez votre compte de facturation et sélectionner les fonctionnalités
- Vérifiez le compte de facturation par défaut affiché pour le confirmer ou sélectionnez-en un autre parmi ceux de votre organisation.
- Configurez votre projet en sélectionnant des fonctionnalités telles que les options de preuve de livraison, les options de livraison estimée, les événements de suivi et le filtrage basé sur les événements.
Étape 2 : saisissez les détails du projet
- Attribuez à votre projet un nom identifiable et unique pour votre organisation.
- Saisissez l’URL de destination et les informations du jeton de sécurité que vous avez créé lors de l’authentification pré-configurée (voir les étapes ci-dessus).
- Pour être notifié des dernières mises à jour du webhook et de toute information relative à une interruption, indiquez une adresse e-mail et la préférence de langue.
Étape 3 : lisez et acceptez les conditions
Une fois les conditions acceptées, y compris le Contrat de licence du FedEx Developer Portal et le Formulaire de commande, cliquez sur Créer. Une fenêtre de confirmation s’affiche.
Il peut y avoir des étapes supplémentaires en fonction de votre sélection de type d’abonnement. Consultez la documentation pour en savoir plus.
Sur la page Aperçu du projet d’API, récupérez vos informations d’identification de test (clé d’API, clé secrète et compte(s) d’expédition) à partir de l’onglet Clé de test.
Étape 1 : demandez un jeton d’accès OAuth
Le jeton d’accès OAuth doit être utilisé avec chaque transaction API. La durée de validité du jeton étant limitée à une heure, vous devez coder votre application par voie de programme de manière à actualiser le jeton avant l’expiration de la session. Pour plus d’informations, reportez-vous à la documentation de l’API Authorization.
Étape 2 : lisez la documentation de l’API
Cliquez sur la documentation de chacune de vos API pour prendre connaissance du contexte métier et comprendre comment utiliser l’API. Connectez-vous pour télécharger la collection d’API JSON via le bouton situé en haut de votre page de documentation. Vous pouvez également examiner des exemples de requêtes pour le point de terminaison qui correspond à l’intégration de votre choix.
Étape 3 : utilisez l’environnement de test (sandbox) pour simuler des transactions
Cliquez sur le point de terminaison souhaité dans la navigation de gauche pour accéder à l’environnement de test spécifique. Identifiez les exemples de requêtes qui correspondent à votre cas d’utilisation, puis utilisez vos identifiants de test et les URL de test FedEx pour implémenter vos appels au point de terminaison, comme décrit dans les exemples de requêtes. Vérifiez que les réponses aux appels d’API que vous recevez correspondent à celles qui figurent dans la documentation. En savoir plus notre expérience de test dans le guide de virtualisation Sandbox.
Tester avec des webhooks
Ce test peut vous permettre de déterminer si l’URL que vous avez créée est valide. Il permet à FedEx d’identifier votre URL et d’établir une connexion avec celle-ci afin de procéder à l’envoi de données. Les tests peuvent également générer des échantillons de données de test utiles pour vérifier et confirmer que vous êtes capable de traiter les données de suivi fournies dans votre application. En revanche, ce test ne permet pas d’authentifier votre adresse URL. Reportez-vous à notre documentation sur les webhooks pour savoir comment tester l’URL de votre webhook.
Consultez la page Aperçu du projet et ouvrez l’onglet Clé de production. Les projets par abonnement au numéro de compte Advanced Integrated Visibility n’ont pas besoin d’être passés en production.
Étape 1 : configurez le projet
- Renommez votre clé si nécessaire.
- Passez en revue le numéro de compte que vous avez sélectionné à l’étape 1 du processus de création de projet. Ce numéro est utilisé pour faire passer votre projet en production. Une fois que votre projet est en production, vous pouvez ajouter d’autres comptes si nécessaire.
Étape 2 : obtenez les clés du projet
Copiez votre clé API de production et votre clé secrète de production sera affichée à un endroit sécurisé. Afin d’assurer la sécurité de votre clé secrète de production, nous n’affichons celle-ci qu’une fois. Si vous la perdez, vous pourrez en générer une nouvelle.
Après avoir obtenu vos clés de production et cliqué sur Suivant, vous verrez les informations de votre projet dans l’onglet Clé de production.
- Pour ajouter plus de comptes d’expédition à votre projet, cliquez sur Modifier en haut du tableau de vos comptes d’expédition.
Les étapes de validation varient selon la région
Ces étapes s’appliquent uniquement aux clients situés aux États-Unis et au Canada. Si vous résidez en dehors de ces pays, veuillez consulter la page de validation de l’API pour trouver de l’aide.
Certaines API nécessitent une validation d’étiquette d’expédition pour pouvoir être utilisées dans notre environnement de production. Découvrez si votre API nécessite une validation.
Étape 1. Développez et testez les API FedEx avec votre application Web
Une fois que vous avez terminé le développement de votre application Web, il convient de terminer les tests avec les informations d’identification de test (clé API, clé secrète et compte(s) d’expédition de test). Votre clé secrète et votre clé API de test seront affichées sur la page Aperçu du projet et pourront être consultées à tout moment.
Étape 2. Mettez votre projet en production
Après avoir effectué les tests avec les API FedEx, vous devez lancer le processus de validation en mettant votre projet en production sur le FedEx Developer Portal. Dès que vous aurez réussi, vous verrez vos clé API et clé secrète de production. Vous ne verrez votre clé secrète de production qu’une seule fois, mais vous pourrez la regénérer plus tard.
Étape 3. Remplissez la page de garde de l’étiquette
Remplissez complètement la page de garde de l’étiquette en indiquant les coordonnées appropriées ainsi que les services que vous comptez implémenter. Indiquez votre numéro de compte et votre clé de production.
Étape 4 : générez et envoyez les étiquettes de test au groupe d’analyse des codes-barres
Générez des étiquettes de test dans l’environnement de test FedEx associé à l’application, puis envoyez-les à l’équipe ou aux équipes d’évaluation des étiquettes FedEx pour approbation. L’évaluation des étiquettes par le groupe d’analyse des codes-barres nécessite trois jours ouvrables.
Appliquez les recommandations suivantes pour ne pas occasionner de retards de traitement :
- Les étiquettes doivent être imprimées et scannées à une résolution minimum de 600 DPI. N’ENVOYEZ PAS DE FICHIERS GÉNÉRÉS PAR LES API.
- Pour les imprimantes thermiques, le type d’image de l’étiquette doit être adapté au modèle de l’imprimante. Exemple : ZPLII pour les imprimantes Zebra.
- Utilisez les informations relatives à l’adresse de l’expéditeur ou du destinataire lors de la création d’exemples d’étiquette pour évaluation. Ne créez que des exemples d’étiquette pour les services spécifiques qui font l’objet de la demande.
- L’étiquette FedEx® de livraison contre remboursement (CR) doit également inclure la livraison contre remboursement correspondante. Renvoyez l’étiquette.
- Les envois FedEx International Express® doivent également inclure l’étiquette du bordereau d’expédition auxiliaire/secondaire.
- Les envois multi-colis (MPS) doivent inclure une étiquette pour chacun des colis de l’envoi.
- Envoyez le PDF et la page de garde de l’étiquette par e-mail à l’adresse label@fedex.com.
- Les étiquettes physiques peuvent être envoyées à l’adresse ci-dessous :
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Si les étiquettes scannées ne présentent pas de défauts visibles (tels que des stries au niveau du code-barres, des taches dans l’encre des zones colorées ou des dommages physiques), elles peuvent alors réussir l’inspection et l’approbation sera accordée.
Si vous envoyez des étiquettes physiques, faites attention à la qualité d’impression et à l’agrandissement ou au rétrécissement accidentel des étiquettes (c’est-à-dire à l’échelle). Ce sont les deux principales raisons pour lesquelles les étiquettes ne réussissent pas le processus d’évaluation.
Étape 5 : vérifiez l’évaluation de l’étiquette
Le groupe d’analyse des codes-barres évaluera les étiquettes de test envoyées et les approuvera ou les rejettera. Le groupe d’analyse des codes à barres vous contactera pour vous informer de leur approbation ou de leur rejet. Si elles sont approuvées, passez à l’étape suivante. Si elles sont rejetées, corrigez les problèmes des étiquettes tel que requis et renvoyez ces dernières pour approbation.
Étape 6 : activez l’application
Une fois que les étiquettes de test sont approuvées pour le statut de production par le groupe d’analyse des codes-barres, celui-ci autorisera vos informations d’identification de production à transmettre la transaction d’étiquette d’expédition identifiée et vous informera par e-mail de la réussite de la validation. Votre approbation est nécessaire pour chaque projet.
Étape 7. Remplacez l’URL et les informations d’identification
Remplacez l’URL et les informations d’identification de test par celles de production. Testez à nouveau votre implémentation dans l’environnement de production en utilisant des exemples de données.
Prérequis
Votre entreprise doit être un Fournisseur FedEx Compatible existant. Si votre entreprise ne fait pas partie du programme Compatible, modifiez votre choix en « Fournisseur non Compatible ».
Étape 1 : recevez une invitation pour rejoindre l’organisation
FedEx créera une organisation et invitera ensuite un membre de l’équipe à rejoindre celle-ci. Cet utilisateur sera désigné comme l’administrateur de votre organisation.
Étape 2 : acceptez l’invitation
Pour accepter l’invitation, vous devez vous connecter à l’aide de votre ID d’utilisateur et de votre mot de passe existants. Si votre ID d’utilisateur existant est déjà associé à une organisation, vous devez en créer un nouveau.
Étape 3 : invitez des utilisateurs
Un administrateur peut inviter des utilisateurs à rejoindre son organisation et leur attribuer des rôles et des projets. Ouvrez l’onglet Utilisateurs. Cliquez sur Ajouter des utilisateurs.
- Sélectionnez un rôle utilisateur : Spectateur, Contributeur ou Administrateur. Pour en savoir plus sur ces rôles, consultez notre guide pour l’administration des organisations.
- Si vous avez des projets existants, attribuez-les à l’utilisateur. Vous pouvez aussi attribuer des utilisateurs aux projets sous chaque page d’aperçu du projet.
- Saisissez les adresses e-mail des utilisateurs que vous souhaitez inviter à rejoindre votre organisation avec le rôle sélectionné.
Consultez le catalogue d’API pour déterminer les API ou webhooks adaptés à votre solution. Votre consultant en technologies clients FedEx et votre responsable de canal Compatible peuvent vous aider à sélectionner les bonnes API pour votre solution, en fonction des besoins de votre entreprise.
Étape 1 : remplissez la FIP
Revenez à la CPC (communauté des fournisseurs Compatible) pour remplir la fiche d’informations produit (FIP).
Étape 2 : vérifiez le projets créés par FedEx
Une fois la FIP approuvée, FedEx créera votre ou vos projets. Chaque version de chacune de vos solutions aura un projet distinct sur le FedEx Developer Portal.
Étape 3 : assistez à la démonstration de l’API avec votre équipe
L’équipe FedEx Compatible, conjointement avec les équipes de vérification et le consultant en technologies clients FedEx, organise une démonstration technique des API avec votre équipe. L’équipe FedEx discutera de la vérification du programme Compatible, des nouvelles fonctionnalités de l’API, et répondra à vos questions.
Sur la page Aperçu du projet d’API, récupérez vos informations d’identification de test (clé d’API et clé secrète) à partir de l’onglet Clé de test.
Étape 1 : créez des clés client
Utilisez l’API Credential Registration pour créer des clés client. Cette clé privée se trouve dans la section API en bas de la page Aperçu du projet d’API.
Étape 2 : demandez un jeton d’accès OAuth
Le jeton d’accès OAuth doit être utilisé avec chaque transaction API. La durée de validité du jeton étant limitée à une heure, vous devez coder votre application par voie de programme de manière à actualiser le jeton avant l’expiration de la session. Pour plus d’informations, reportez-vous à la documentation de l’API Authorization. Lors de l’affichage des exemples de code, assurez-vous que le « Revendeur » est choisi dans la liste déroulante des exemples.
Étape 3 : lisez la documentation de l’API
Cliquez sur la documentation de chacune de vos API pour prendre connaissance du contexte métier et comprendre comment utiliser l’API. Connectez-vous pour télécharger la collection d’API JSON via le bouton situé en haut de votre page de documentation. Vous pouvez également examiner des exemples de requêtes pour le point de terminaison qui correspond à l’intégration de votre choix.
Étape 4 : utilisez l’environnement de test (sandbox) pour simuler des transactions
Cliquez sur le point de terminaison souhaité dans la navigation de gauche pour accéder à l’environnement de test spécifique. Identifiez les exemples de requêtes qui correspondent à votre cas d’utilisation, puis utilisez vos identifiants de test et les URL de test FedEx pour implémenter vos appels au point de terminaison, comme décrit dans les exemples de requêtes. Vérifiez que les réponses aux appels d’API que vous recevez correspondent à celles qui figurent dans la documentation. En savoir plus notre expérience de test dans le guide de virtualisation Sandbox.
Étape 5 : vérifiez chaque solution
Après avoir entièrement testé vos solutions, envoyez les cas de test à l’équipe de vérification pour vérifier chaque solution. FedEx examinera en détail tout ce qui a été soumis et vous informera dès que votre vérification sera approuvée.
Tester avec des webhooks
Si votre organisation a accès aux webhooks, la phase de test peut vous aider à mieux déterminer si l’URL que vous avez créée est valide. Il permet à FedEx d’identifier votre URL et d’établir une connexion avec celle-ci afin de procéder à l’envoi de données. Les tests peuvent également générer des échantillons de données de test utiles pour vérifier et confirmer que vous êtes capable de traiter les données de suivi fournies dans votre application. En revanche, ce test ne permet pas d’authentifier votre adresse URL. Reportez-vous à notre documentation sur les webhooks pour savoir comment tester l’URL de votre webhook.
FedEx mettra ensuite votre ou vos projets en production. Consultez la page Aperçu du projet d’API et ouvrez l’onglet Clé de production. Cliquez sur Générer la clé secrète sous la colonne Clé secrète.
Vous êtes maintenant en mesure de tester à nouveau votre mise en œuvre dans l’environnement de production en utilisant des exemples de données.
Prérequis
Vous devez posséder un ID d’utilisateur FedEx et un compte pour vous connecter au FedEx Developer Portal et créer une organisation.
Vous pouvez soit créer une organisation si elle n’existe pas encore pour votre entreprise, soit rejoindre l’organisation existante de votre entreprise.
Créer une organisation
Dans la barre de navigation, cliquez sur « Créer ou rejoindre une organisation ».
Remarque : en tant que créateur, vous êtes automatiquement désigné comme l’administrateur de l’organisation.
Les administrateurs peuvent :
inviter des utilisateurs ;
attribuer des rôles (par exemple, contributeur, spectateur) et des projets aux utilisateurs ;
gérer les comptes d’expédition.
Pour en savoir plus sur ces rôles, consultez notre guide sur l’administration des organisations.
Pour le type d’entreprise, sélectionnez « Vend ou propose une solution logicielle qui utilise la technologie FedEx et est un fournisseur d’intégrateur FedEx validé ».
Indiquez le nom de votre entreprise, l’URL de votre site Web ainsi qu’un nom d’organisation unique. Le nom de l’organisation peut correspondre à celui de votre entreprise ou représenter un groupe spécifique (service, division, région, localisation). Ces informations sont nécessaires pour valider votre demande.
Remarque : choisissez un nom d’organisation que tous les autres utilisateurs reconnaîtront (par exemple, nom de l’entreprise, service, région, localisation).
Précisez la localisation de votre entreprise et l’endroit où votre solution logicielle sera vendue ou distribuée.
Ajoutez un compte de facturation et authentifiez le compte.
Remarque : en tant que fournisseur de services d’expédition et de logistique dans le programme d’Intégrateur FedEx, vous devez utiliser votre propre numéro de compte. Vous ne pouvez pas utiliser le compte FedEx d’un client.
Saisissez votre numéro de compte FedEx. Si vous n’avez pas de compte FedEx existant, créez-en un sur fedex.com ou contactez un représentant de l’assistance FedEx.
Saisissez le pseudonyme du compte et l’adresse de facturation associée au compte. Sélectionnez « Suivant ».
Remarque : l’adresse de facturation doit correspondre à celle dont nous disposons pour ce compte. Il s’agira du compte de facturation par défaut de votre organisation.
Pour terminer la création de votre organisation, vous devez authentifier votre compte. Choisissez une option d’authentification (téléphone [disponible uniquement pour les intégrateurs aux États-Unis et au Canada], adresse e-mail, SMS) et sélectionnez « Suivant ».
Une fois le code d’authentification reçu, saisissez-le et sélectionnez « Soumettre ».
Accepter les conditions
Lisez le Contrat d’Intégrateur FedEx et le Manuel du Programme. Cochez les cases pour confirmer que vous acceptez les conditions, puis sélectionnez « Accepter ».
Un écran de confirmation s’affiche. Cliquez sur « Gérer l’organisation » pour modifier les informations si nécessaire.
Inviter des utilisateurs
Remarque : seuls les administrateurs peuvent inviter des utilisateurs.
Sélectionnez « Gérer l’organisation » dans le menu de navigation de gauche.
Accédez à l’onglet « Utilisateurs » et sélectionnez « Ajouter des utilisateurs ».
Remplissez le formulaire et attribuez le rôle approprié aux nouveaux utilisateurs : spectateur, contributeur ou administrateur.
Pour en savoir plus sur les rôles utilisateur, consultez le guide pour l’administration des organisations.
Affectez les utilisateurs à des projets (si applicable) dans le menu déroulant « Projets ».
Saisissez les adresses e-mail de chaque utilisateur, puis sélectionnez « Inviter ».
Rejoindre une organisation existante
Demandez une invitation : demandez à l’administrateur de votre organisation de vous envoyer une invitation. Vous avez 24 heures pour l’accepter avant son expiration. Si nécessaire, demandez à l’administrateur de la renvoyer.
Acceptez l’invitation : connectez-vous avec votre ID d’utilisateur et votre mot de passe. Si votre ID est déjà lié à une autre organisation, vous devrez en créer un nouveau.
Créer un projet API
Accédez à la page Mes projets et sélectionnez Créer un projet.
Remplissez le champ Nom du projet. Le format de nom recommandé est « Nomduprojet_nomdelapplication ». Sélectionnez Suivant lorsque vous avez terminé.
Sélectionnez les produits API et Advanced Integrated Visibility pour votre projet.
Remarque : les produits Advanced Integrated Visibility ne sont disponibles que pour les fournisseurs Intégrateur FedEx aux États-Unis.
Remarque : si vous sélectionnez des produits payants, il vous sera demandé d’attribuer un compte de facturation au projet et d’accepter les conditions requises.
Attribuer un compte de facturation et accepter les conditions
Attribuez un compte de facturation depuis la liste des comptes ajoutés à l’organisation. Cette étape n’est nécessaire que si vous avez sélectionné un produit payant au préalable.
Acceptez les conditions générales associées au produit.
Confirmer les informations
Passez en revue les produits sélectionnés. Vérifiez le compte de facturation fourni.
Vérifiez et acceptez le contrat de licence du FedEx Developer Portal.
Cliquez sur Créer pour générer votre projet et afficher les identifiants de test.
Configurer Advanced Integrated Visibility dans un projet
Conditions préalables
Conditions préalables
- Tarification : les abonnés sont facturés mensuellement en fonction du nombre de numéros de suivi. Consultez le formulaire de commande pour en savoir plus sur nos tarifs.
- Configurer des comptes : Advanced Integrated Visibility nécessite un compte de facturation basé aux États-Unis et au moins un compte d’expédition, ces deux types de comptes étant mutuellement exclusifs. Seuls les administrateurs peuvent ajouter des comptes sur la page Gérer l’organisation.
Créer une URL de redirection valide dans l’application ou la plateforme de destination – L’URL de l’application ou de la plateforme :
doit utiliser le protocole HTTPS pour garantir la sécurité ;
ne doit pas inclure l’espace IP RFC1918, les sous-domaines de fedex.com, ni les adresses IP directes (par exemple, 127.0.0.1).
Générer un jeton de sécurité
Doit contenir entre 26 et 100 caractères et inclure :
- 1 lettre majuscule ;
- 1 lettre minuscule ;
- 1 chiffre.
Exemple : Y1F6OiVUQW2JPSElmRE9U0IY5
Configurer Advanced Integrated Visibility
Choisissez Advanced Integrated Visibility. Sélectionnez les fonctionnalités telles que la preuve de livraison, la livraison estimée, les événements de suivi et le filtrage basé sur les événements.
Saisissez votre URL de destination et votre jeton de sécurité.
Indiquez une adresse e-mail pour les mises à jour d’Advanced Integrated Visibility et les notifications de panne.
Confirmer les informations
Vérifiez et acceptez le contrat de licence du FedEx Developer Portal ainsi que le formulaire de commande.
Sélectionnez Créer pour terminer la configuration.
Remarque : il peut y avoir des étapes supplémentaires en fonction de votre type d’abonnement. Pour plus d’informations, reportez-vous à la documentation.
Récupérer les identifiants de test et commencer les tests
Consulter la documentation sur les API
- Consultez la documentation sur les API pour comprendre les différentes API que nous proposons, ainsi que leur contexte commercial et leurs processus d’intégration.
- Téléchargez le schéma JSON depuis la page de documentation de l’API concernée.
- Passez en revue les exemples de requêtes pour les points de terminaison souhaités.
Obtenir les identifiants de test
Sur la page Aperçu du projet, accédez à l’onglet Clés API. Votre clé API et votre clé secrète sont répertoriées sous l’en-tête Clé de test.
Consulter la documentation sur les API
- Un jeton OAuth est requis pour toutes les transactions API et est valable une heure.
- Votre application doit actualiser le jeton avant son expiration.
- Pour plus d’informations, reportez-vous à la documentation de l’API Authorization.
Tester les transactions d’API dans le sandbox
- Accédez à l’API concernée dans le catalogue d’API et sélectionnez Documentation.
- Sélectionnez le point de terminaison d’API souhaité dans le menu de gauche.
- Utilisez des exemples de requêtes correspondant à votre cas d’utilisation.
- Mettez en œuvre les appels d’API à l’aide de vos identifiants de test et des URL de test FedEx.
- Vérifiez les réponses par rapport à la documentation.
- Consultez le guide de virtualisation Sandbox pour plus de détails.
Tester Advanced Integrated Visibility
Le test Advanced Integrated Visibility valide votre format d’URL et aide à établir une connexion entre FedEx et votre application.
Ce test fournit des exemples de données de test pour le traitement des informations de suivi.
Remarque : ce test ne permet pas d’authentifier votre adresse URL.
Consultez la documentation Advanced Integrated Visibility pour en savoir plus.
La validation est requise pour passer les API en production. Le niveau de validation varie selon l’API.
Développer et tester des API FedEx
- Utilisez vos identifiants de test (clé API et clé secrète) à partir de la page Aperçu du projet.
- Identifiez les cas de test pour les régions/territoires où vous prévoyez de déployer votre solution (reportez-vous à la base de référence des cas de test de l’Intégrateur).
- Avant d’exécuter des cas de test, effectuez les transactions d’enregistrement en utilisant les numéros de compte de test fournis.
- Exécutez tous les cas de test requis.
Accédez à la page Aperçu du projet.
Sélectionnez « Demander les clés de production ». FedEx recevra votre demande de clés de production et vous avertira lors de leur approbation.
Remplir la FIP et la page de garde de validation
Remplissez la fiche d’informations produit (FIP) et la page de garde de validation de l’Intégrateur en indiquant vos coordonnées et les services FedEx prévus.
Soumettre des livrables
Rassemblez et compressez les livrables dans un fichier .zip afin d’éviter les restrictions imposées par les fournisseurs d’adresse e-mail. Envoyez le tout à l’adresse validationmtp@fedex.com.
Livrables requis
- FIP remplie (PDF)
- Page de garde de validation remplie (PDF)
Captures d’écran (PDF) :
Solution client affichant les services FedEx/la manutention spéciale
Clause de non-responsabilité
CLUF
Parcours d’enregistrement du client final
- Transactions d’enregistrement du client final avec authentification multifacteur (JSON)
- Étiquettes d’expédition numérisées pour tous les cas de test applicables (PDF/PNG)
- Transactions d’expédition pour trois formats d’étiquettes : PDF, PNG et ZPL (JSON) (pour les API Shipping et Rating applicables)
Bonnes pratiques pour éviter les retards
- Les étiquettes doivent être imprimées et scannées à une résolution minimum de 600 DPI.
- Les étiquettes pour imprimante thermique doivent être compatibles avec le modèle de l’imprimante (p. ex. ZPLII pour les imprimantes Zebra).
- Les envois FedEx International Express® nécessitent une étiquette de bordereau d’expédition auxiliaire.
- Les envois multicolis (MPS) doivent inclure une étiquette pour chaque colis.
Évaluation des étiquettes
L’équipe de validation approuvera ou rejettera votre demande.
- Si elle est rejetée, apportez des corrections et soumettez à nouveau la demande en suivant les conseils.
- Si elle est approuvée, vous recevrez un e-mail confirmant la validation. Une fois que vous aurez reçu cet e-mail, vos identifiants de production seront autorisés pour les transactions d’étiquette d’expédition.
Suivre les instructions post-validation
Passez en revue et mettez en œuvre toutes les exigences post-validation, le cas échéant.
Une fois notifié que vos clés de production ont été approuvées, récupérez vos clés de production dans l’onglet « Aperçu du projet ».
- Copiez et stockez votre clé API de production et votre clé secrète de manière sécurisée.
- La clé secrète est affichée une seule fois. Si vous la perdez, vous devrez en régénérer une nouvelle.
