Pour commencer
FedEx Developer Portal offre une gamme d’interfaces de programmation d’applications (API) permettant d’intégrer FedEx à vos applications. Ces instructions vous guideront pour configurer une organisation, créer un projet, tester votre intégration, déplacer 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 fournisseurs compatibles FedEx et les fournisseurs intégrateurs FedEx validés.
Expéditeur FedEx :
Entreprise qui expédie avec FedEx et qui doit intégrer les API FedEx à ses propres applications.
Fournisseur de solutions ou de services :
Entreprise qui doit intégrer les API FedEx afin de créer une solution, une application ou un module qui peut être vendu et/ou distribué à une organisation externe qui expédie avec FedEx.
- Fournisseur compatible FedEx : entreprise vérifiée ayant une entente contractuelle dans le cadre du programme FedEx Compatible.
- Fournisseur intégrateur FedEx : entreprise validée ayant une entente contractuelle dans le cadre du programme intégrateur de FedEx.
Sélectionnez ci-dessous l’option qui décrit le mieux votre entreprise. Peu importe votre type d’utilisateur, une expérience de démarrage est offerte.Sélectionnez pour commencer.
Sélectionnez pour commencer.
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.
Condition préalable
Vous devez avoir un id utilisateur FedEx pour vous connecter à 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 nouvelle organisation
Dans la barre de navigation, cliquez sur Se joindre à une organisation ou en créer une.
Remarque : en tant que créateur, vous êtes automatiquement désigné comme administrateur de l’organisation.
Les administrateurs peuvent :
Invitez les utilisateurs à rejoindre
Attribuer des rôles aux utilisateurs (p. ex., contributeur, observateur) et des projets
Gérer les comptes d’envoi
Pour en savoir plus sur ces rôles, consultez notre Guide d’administration de l’organisation.
Pour le type d’entreprise, sélectionnez « Vend ou fournit une solution logicielle qui utilise la technologie de FedEx et qui est un fournisseur intégrateur validé de FedEx ».
Fournissez le nom de votre entreprise, l’URL de votre site Web et un nom d’organisation unique. Le nom de l’organisation peut correspondre à celui de votre entreprise ou représenter un groupe spécifique (département, division, région, emplacement). Ces renseignements 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, département, région, emplacement).
Indiquez l’emplacement de votre entreprise et les endroits où votre solution logicielle sera vendue ou distribuée.
Ajouter un compte de facturation et authentifier le compte
Remarque : en tant que fournisseur de services d’expédition et de logistique dans le programme FedEx intégrateur, vous devez utiliser votre propre numéro de compte. Vous ne pouvez pas utiliser le compte FedEx d’un client.
Entrez votre numéro de compte FedEx. Si vous n’avez pas de compte FedEx existant, ouvrez-en un au FedEx.com ou contactez un représentant du support FedEx.
Entrez un nom de compte et l’adresse de facturation associée au compte. Sélectionnez Suivant.
Remarque : l’adresse de facturation doit correspondre à nos dossiers pour ce compte. Il s‘agit 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, courriel, texte) et sélectionnez Suivant.
Une fois le code reçu, saisissez-le puis sélectionnez « Soumettre ».
Accepter les conditions
Lisez l’Entente mondiale d’intégrateur et le Manuel du programme. Cochez les cases pour confirmer que vous acceptez les conditions, puis cliquez sur Accepter.
Un écran de confirmation apparaîtra. Cliquez sur Gérer l’organisation pour modifier les détails 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.
Allez à l’onglet Utilisateurs et sélectionnez Ajouter des utilisateurs.
Remplissez le formulaire et attribuez le rôle approprié au(x) nouveau(x) utilisateur(s) : lecteur, collaborateur ou administrateur.
Pour obtenir plus d’informations sur les rôles des utilisateurs, consultez le Guide d’administration de l’organisation.
Assignez les utilisateurs aux projets (le cas échéant), dans le menu déroulant Projets.
Entrez les adresses courriel de chaque utilisateur, puis sélectionnez Inviter.
Joindre une organisation existante
Demander une invitation : demandez à l’administrateur de votre organisation de vous envoyer une invitation. Vous avez 24 heures pour accepter avant qu’il n’expire. Si nécessaire, demandez à l’administrateur de le renvoyer.
Acceptez l’invitation : ouvrez une session avec votre ID utilisateur et votre mot de passe actuels. Si votre identifiant d’utilisateur est déjà lié à une autre organisation, vous devez en créer un nouveau.
Joindre une organisation existante
Étape 1 : demander à l’administrateur de votre organisation de vous envoyer une invitation.
Si votre entreprise a déjà créé une organisation, demandez à l’administrateur de l’organisation de vous inviter à vous y joindre. Vous aurez 24 heures pour accepter son invitation. Si vous dépassez ce délai, vous pouvez lui demander de la renvoyer.
Étape 2 : accepter l’invitation.
Pour accepter l’invitation, vous devrez vous connecter à l’aide de votre ID utilisateur et de votre mot de passe existants ou, si votre ID utilisateur est déjà associé à une organisation, vous devrez en créer un nouveau.
Créez un projet API
Visitez la page Mes projets et ouvrez l’onglet API. Cliquez sur le bouton Créer un projet API.
Étape 1 : sélectionnez la ou les API que vous souhaitez inclure dans votre projet
Passez en revue les quotas d’API, les limites de taux et les détails de validation de l’API.
Étape 2 : configurer les détails du projet
- Donnez à votre projet un nom identifiable et unique à votre organisation.
- Sélectionnez les pays dans lesquels vous prévoyez d’effectuer des envois 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 pouvez toujours ajouter ou supprimer des pays ultérieurement.
- Pour recevoir des avis sur les dernières mises à jour des API et sur les renseignements relatifs aux pannes, définissez vos préférences en matière d’avis.
Étape 3 : lisez et acceptez les conditions, y compris le contrat de licence du FedEx Developer Portal
Une fois que vous avez accepté les conditions et cliqué sur le bouton Créer, un écran de confirmation s’affichera. Vous pouvez désormais voir vos identifiants de test dans votre nouveau projet.
Créer un projet webhook
Conditions préalables
- Consultez les tarifs : des frais mensuels sont facturés aux abonnés en fonction du nombre de numéros de repérage. Consultez le Guide des tarifs pour en savoir plus sur la tarification.
- Configurer les comptes : le webhook de visibilité intégrée avancée nécessite un compte de facturation basé aux États-Unis ainsi qu’au moins un compte d’expédition. Ces deux types de comptes sont mutuellement exclusifs. Seuls les administrateurs peuvent ajouter des comptes de facturation et d’expédition sur la page Gérer l’organisation.
Créez une URL (de rappel) valide dans votre application ou plateforme de destination
Votre URL de destination sera utilisée pour recevoir les codes d’authentification, les messages ainsi que les notifications de données utiles de type webhook provenant de FedEx. Votre URL doit utiliser le protocole HTTPS afin d’assurer la sécurité. Votre URL sera bloquée si elle contient :
- Une adresse IP de l’espace RFC1918
- 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é comme clé secrète pour authentifier et valider les renseignements transmis entre votre organisation et FedEx. Votre jeton de sécurité doit inclure les éléments suivants :
- Il doit être composé d’un minimum de 26 caractères et d’un maximum de 100 caractères.
- 1 majuscule
- 1 minuscule
- 1 chiffre
Exemple : Y1F6OiVUQW2JPSElmRE9U0IY5
Une fois que vous avez défini votre URL et votre jeton de sécurité, vous êtes prêt à créer un projet webhook. Visitez la page Mes projets et ouvrez l’onglet Webhooks. Cliquez sur le bouton Créer un projet Webhook.
Sélectionnez le type d’abonnement
Les expéditeurs FedEx peuvent abonner leurs événements à des numéros de compte ou à des numéros de suivi.
Étape 1 : confirmez votre compte de facturation et sélectionnez les fonctionnalités
- Passez en revue le compte de facturation par défaut indiqué pour le confirmer ou en choisir un autre dans 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 : entrer les détails du projet
- Donnez à votre projet un nom identifiable et unique à votre organisation.
- Entrez les détails de votre URL de destination et de votre jeton de sécurité créés lors de l’authentification préalable (voir les étapes ci-dessus).
- Pour recevoir les dernières mises à jour concernant les webhooks et les avis d’interruption de service, entrez une adresse courriel et la langue de votre choix.
Étape 3 : lisez et acceptez les conditions
Une fois que vous avez accepté les conditions, y compris le contrat de licence du FedEx Developer Portal et le formulaire de commande, puis cliqué sur le bouton Créer, un écran de confirmation s’affichera.
Des étapes supplémentaires pourraient être requises selon le type d’abonnement sélectionné. Consultez la documentation pour en savoir plus.
Sur la page Présentation du projet API, récupérez vos identifiants de test — la clé API, la clé secrète et le ou les comptes 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é pour chaque transaction API. Comme le jeton n’est valable que pendant une heure, vous devrez coder votre application par programmation pour actualiser le jeton avant l’expiration de la session. Consultez la documentation sur API Authorization pour en savoir plus.
Étape 2 : consultez la documentation API
Cliquez sur la documentation de chacune de vos API pour en connaître le contexte opérationnel et comprendre comment l’utiliser. Connectez-vous pour télécharger la collection API en format JSON à l’aide du bouton situé en haut de la page de documentation. Vous pouvez également consulter des exemples de demandes pour le point de terminaison qui correspond à l’intégration souhaitée.
Étape 3 : utilisez l’environnement sandbox pour tester des transactions exemples
Cliquez sur le point de terminaison souhaité dans le menu de navigation de gauche pour accéder à l’environnement sandbox correspondant. Repérez les requêtes exemples qui correspondent à votre cas d’utilisation, puis utilisez vos identifiants de test et les URL de test FedEx pour effectuer vos appels au point de terminaison, comme indiqué dans les exemples de requêtes. Vérifiez que les réponses à l’appel API que vous recevez correspondent à celles indiquées dans la documentation. Pour en savoir plus sur notre environnement de test, consultez le Guide de virtualisation de la sandbox.
Tests avec les webhooks
Les tests peuvent vous aider à vérifier si l’URL que vous avez créée est valide. Ils permettent à FedEx d’identifier votre URL et d’établir une connexion avec votre URL pour envoyer des données. Les tests peuvent également vous fournir des échantillons de données de test qui peuvent vous aider à vérifier et à confirmer si vous êtes en mesure de traiter les données de suivi fournies dans votre application. Toutefois, les tests ne permettent pas d’authentifier votre URL. Consultez nos documents sur les webhooks pour savoir comment tester l’URL de votre webhook.
Visitez votre page Présentation du projet et ouvrez l’onglet Clé de production. Les projets d’abonnement au numéro de compte pour Advanced Integrated Visibility n’ont pas besoin d’être passés en production.
Étape 1 : configurer le projet
- Renommez votre clé au besoin.
- Passez en revue le numéro de compte que vous avez sélectionné à l’étape 1 du processus de création de projet. Il est utilisé pour mettre votre projet en production. Une fois que votre projet est en production, vous pouvez ajouter d’autres comptes au besoin.
Étape 2 : obtenez les clés du projet
Copiez votre clé API de production ainsi que votre clé secrète de production dans un emplacement sécurisé. Pour assurer la sécurité de votre clé secrète de production, nous ne l’affichons qu’une seule fois. Si vous la perdez, vous pouvez en générer une nouvelle.
Après avoir obtenu les clés de votre projet et cliqué sur Suivant, les détails de votre projet s’afficheront dans l’onglet Clé de production.
- Pour ajouter d’autres comptes d’expédition à votre projet, cliquez sur Modifier en haut du tableau des comptes d’expédition.
Les étapes de validation varient selon la région
Les étapes suivantes s’appliquent uniquement aux clients des États-Unis et du Canada. Si vous résidez à l’extérieur de ces pays, visitez la page Validation des API pour obtenir de l’aide.
Certaines API nécessitent une validation d’étiquette d’expédition pour pouvoir être utilisées dans notre environnement de production. Vérifiez si votre API nécessite une validation.
Étape 1. Développez et testez les API FedEx avec votre application Web
Lorsque vous avez terminé le développement de votre application Web, vous devez terminer les tests en utilisant les identifiants de test (compte(s) d’expédition de test, clé API et clé secrète). 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 votre clé API et votre clé secrète de production. Vous ne verrez votre clé secrète de production qu’une seule fois, mais vous pourrez la régénérer plus tard.
Étape 3. Remplissez la feuille de couverture de l’étiquette
Remplissez complètement la feuille de couverture de l’étiquette en indiquant les coordonnées appropriées ainsi que les services que vous comptez implanter. Ajoutez 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 les é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. Veuillez compter trois jours ouvrables pour l’évaluation des étiquettes par le groupe d’analyse des codes-barres.
Suivez ces pratiques exemplaires pour éviter les retards de traitement :
- Les étiquettes doivent être imprimées et balayées à une résolution minimale de 600 ppp. 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 renseignements sur l’adresse de l’expéditeur ou du destinataire lorsque vous créez des exemples d’étiquettes pour évaluation. Créez uniquement des exemples d’étiquettes pour les services qui font l’objet de la demande.
- L’étiquette FedEx🅪 Contre remboursement (C.O.D.) doit également inclure l’étiquette de retour C.O.D. Étiquette de retour.
- Les envois FedEx International Express🅪 doivent aussi comprendre l’étiquette de la lettre de transport aérien auxiliaire/secondaire.
- Les envois multipièces doivent inclure une étiquette pour chacun des colis de l’envoi.
- Envoyez le PDF et la feuille de couverture de l’étiquette par courriel à : label@fedex.com.
- Les étiquettes papier peuvent être envoyées à l’adresse ci-dessous :
Services FedEx
Tests WTC — Solutions d’affaires
10 FedEx Parkway
2e étage — Aile horizontale
Collierville, TN 38017
Si les étiquettes balayées ne présentent pas de défauts visibles (tels que des stries au niveau du code-barres, des taches d’encre ou des dommages physiques), elles réussiront l’inspection et l’approbation sera accordée.
Si vous envoyez des étiquettes papier, 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 : passez en revue 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. Il communiquera ensuite avec vous 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 comme requis puis renvoyez-les 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, ce dernier autorisera vos identifiants de production à transmettre la transaction d’étiquette d’expédition identifiée et vous informera par courriel de la réussite de la validation. Votre approbation est accordée projet par projet.
Étape 7. Remplacez l’URL et les identifiants
Remplacez l’URL et les identifiants de test par l'URL et les identifiants de production. Testez à nouveau votre implantation dans l’environnement de production en utilisant des exemples de données.
Condition préalable
Votre entreprise doit déjà être un fournisseur compatible FedEx. Si votre entreprise ne fait pas partie du programme Compatible, modifiez votre sélection ci-dessus pour « Fournisseur non compatible ».
Étape 1 : recevez une invitation pour joindre l’organisation
FedEx créera une organisation et invitera ensuite un membre de l’équipe à se joindre à l’organisation. Cet utilisateur sera désigné comme étant l’administrateur au sein de votre organisation.
Étape 2 : accepter l’invitation
Pour accepter l’invitation, vous devrez vous connecter à l’aide de votre ID utilisateur et de votre mot de passe existants ou, si votre ID utilisateur est déjà associé à une organisation, vous devrez en créer un nouveau.
Étape 3 : inviter des utilisateurs
Un administrateur peut inviter des utilisateurs à se joindre à son organisation et leur attribuer des rôles et des projets. Ouvrez l’onglet Utilisateurs. Cliquez sur le bouton Ajouter des utilisateurs.
- Sélectionnez un rôle pour l’utilisateur : lecteur, collaborateur ou administrateur. Pour en savoir plus sur les rôles, consultez notre Guide d’administration des organisations.
- Si vous avez déjà des projets existants, assignez-en un à l’utilisateur. Vous pouvez aussi assigner des utilisateurs à des projets à partir de n’importe quelle page de présentation d’un projet.
- Entrez les adresses courriel des utilisateurs que vous souhaitez ajouter à votre organisation sous le rôle sélectionné.
Consultez le Catalogue des API pour déterminer les API ou webhooks les mieux 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 le PIW
Retournez dans la Communauté des fournisseurs compatibles (CPC) pour remplir la fiche de renseignements sur le produit (Product Information Worksheet — PIW).
Étape 2 : passez en revue le ou les projets créés par FedEx
Une fois la fiche approuvée, FedEx créera votre ou vos projets. Chaque version de chacune de vos solutions fera l’objet d’un projet distinct dans le FedEx Developer Portal.
Étape 3 : assistez à la démonstration API avec votre équipe
L’équipe FedEx Compatible, en collaboration avec les équipes FedEx CTC et de vérification, organisera une démonstration technique des API avec votre équipe. L’équipe FedEx y abordera la vérification dans le cadre du programme Compatible, les nouvelles fonctionnalités des API et répondra à vos questions.
Sur la page Présentation du projet API, récupérez vos identifiants de test — la clé API et la 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. Il s’agit d’une API privée, accessible uniquement dans la section API au bas de votre page Présentation du projet API.
Étape 2 : demandez un jeton d’accès OAuth
Le jeton d’accès OAuth doit être utilisé pour chaque transaction API. Comme le jeton n’est valable que pendant une heure, vous devrez coder votre application par programmation pour actualiser le jeton avant l’expiration de la session. Consultez la documentation sur API Authorization pour en savoir plus. Lors de l’affichage des exemples de code, assurez-vous que l’entrée « Revendeur » est choisie dans le menu déroulant des exemples.
Étape 3 : consultez la documentation API
Cliquez sur la documentation de chacune de vos API pour en connaître le contexte opérationnel et comprendre comment l’utiliser. Connectez-vous pour télécharger la collection API en format JSON à l’aide du bouton situé en haut de la page de documentation. Vous pouvez également consulter des exemples de demandes pour le point de terminaison qui correspond à l’intégration souhaitée.
Étape 4 : utilisez l’environnement sandbox pour tester des transactions exemples
Cliquez sur le point de terminaison souhaité dans le menu de navigation de gauche pour accéder à l’environnement sandbox correspondant. Repérez les requêtes exemples qui correspondent à votre cas d’utilisation, puis utilisez vos identifiants de test et les URL de test FedEx pour effectuer vos appels au point de terminaison, comme indiqué dans les exemples de requêtes. Vérifiez que les réponses à l’appel API que vous recevez correspondent à celles indiquées dans la documentation. Pour en savoir plus sur notre environnement de test, consultez le Guide de virtualisation de la sandbox.
Étape 5 : vérifiez chaque solution
Une fois vos solutions entièrement testées, soumettez les cas de test à l’équipe de vérification pour valider 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.
Tests avec les webhooks
Si votre organisation a accès aux webhooks, les tests peuvent vous aider à vérifier si l’URL que vous avez créée est valide. Ils permettent à FedEx d’identifier votre URL et d’établir une connexion avec votre URL pour envoyer des données. Les tests peuvent également vous fournir des échantillons de données de test qui peuvent vous aider à vérifier et à confirmer si vous êtes en mesure de traiter les données de suivi fournies dans votre application. Toutefois, les tests ne permettent pas d’authentifier votre URL. Consultez nos documents sur les webhooks pour savoir comment tester l’URL de votre webhook.
FedEx mettra ensuite votre ou vos projets en production. Visitez votre page Présentation du projet API et ouvrez l’onglet Clé de production. Cliquez sur le lien 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.
Condition préalable
Vous devez avoir un id utilisateur FedEx ainsi qu’un compte pour vous connecter à FedEx Developer Portal et créer une organisation.
Vous pouvez créer une organisation, si elle n’existe pas encore pour votre entreprise, ou vous joindre à l’organisation existante de votre entreprise.
Créer une nouvelle organisation
Dans la barre de navigation, cliquez sur Se joindre à une organisation ou en créer une.
Remarque : en tant que créateur, vous êtes automatiquement désigné comme administrateur de l’organisation.
Les administrateurs peuvent :
Invitez les utilisateurs à rejoindre
Attribuer des rôles aux utilisateurs (p. ex., contributeur, observateur) et des projets
Gérer les comptes d’envoi
Pour en savoir plus sur ces rôles, consultez notre Guide d’administration de l’organisation.
Pour le type d’entreprise, sélectionnez « Vend ou fournit une solution logicielle qui utilise la technologie de FedEx et qui est un fournisseur intégrateur validé de FedEx ».
Fournissez le nom de votre entreprise, l’URL de votre site Web et un nom d’organisation unique. Le nom de l’organisation peut correspondre à celui de votre entreprise ou représenter un groupe spécifique (département, division, région, emplacement). Ces renseignements 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, département, région, emplacement).
Indiquez l’emplacement de votre entreprise et les endroits où votre solution logicielle sera vendue ou distribuée.
Ajouter un compte de facturation et authentifier le compte
Remarque : en tant que fournisseur de services d’expédition et de logistique dans le programme FedEx intégrateur, vous devez utiliser votre propre numéro de compte. Vous ne pouvez pas utiliser le compte FedEx d’un client.
Entrez votre numéro de compte FedEx. Si vous n’avez pas de compte FedEx existant, ouvrez-en un au FedEx.com ou contactez un représentant du support FedEx.
Entrez un nom de compte et l’adresse de facturation associée au compte. Sélectionnez Suivant.
Remarque : l’adresse de facturation doit correspondre à nos dossiers pour ce compte. Il s‘agit 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, courriel, texte) et sélectionnez Suivant.
Une fois le code reçu, saisissez-le puis sélectionnez « Soumettre ».
Accepter les conditions
Lisez le contrat d’intégrateur de FedEx et le manuel du programme. Cochez les cases pour confirmer que vous acceptez les conditions, puis cliquez sur Accepter.
Un écran de confirmation apparaîtra. Cliquez sur Gérer l’organisation pour modifier les détails 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.
Allez à l’onglet Utilisateurs et sélectionnez Ajouter des utilisateurs.
Remplissez le formulaire et attribuez le rôle approprié au(x) nouveau(x) utilisateur(s) : lecteur, collaborateur ou administrateur.
Pour obtenir plus d’informations sur les rôles des utilisateurs, consultez le Guide d’administration de l’organisation.
Assignez les utilisateurs aux projets (le cas échéant), dans le menu déroulant Projets.
Entrez les adresses courriel de chaque utilisateur, puis sélectionnez Inviter.
Joindre une organisation existante
Demander une invitation : demandez à l’administrateur de votre organisation de vous envoyer une invitation. Vous avez 24 heures pour accepter avant qu’il n’expire. Si nécessaire, demandez à l’administrateur de le renvoyer.
Acceptez l’invitation : ouvrez une session avec votre ID utilisateur et votre mot de passe actuels. Si votre identifiant d’utilisateur est déjà lié à une autre organisation, vous devez en créer un nouveau.
Créez un projet API
Allez sur votre page Mes projets et sélectionnez Créer un projet.
Remplissez le champ Nom du projet. Le format de nom recommandé est « Nom du projet_nom de l’application ». Sélectionnez Suivant une fois terminé.
Sélectionnez les produits API et Visibilité intégrée avancée pour votre projet.
Remarque : les produits de visibilité intégrée avancée ne sont disponibles que pour les intégrateurs FedEx américains.
Remarque : si vous sélectionnez des produits payants, vous serez invité à attribuer un compte de facturation au projet et à accepter les conditions requises.
Attribuez la facturation et acceptez les conditions
Assignez un compte de facturation à partir de la liste des comptes ajoutés à l’organisation. Cette étape est seulement nécessaire si vous avez sélectionné un produit payant précédemment.
Acceptez les modalités associées au produit.
Confirmer les détails
Examinez les produits sélectionnés. Vérifiez le compte de facturation fourni.
Consultez et acceptez le contrat de licence du FedEx Developer Portal.
Cliquez sur Créer pour générer votre projet et afficher vos identifiants de test.
Configurer la visibilité intégrée avancée dans un projet
Conditions préalables
Conditions préalables
- Consultez les tarifs : des frais mensuels sont facturés aux abonnés en fonction du nombre de numéros de repérage. Veuillez vous recommander au bon de commande pour en savoir plus sur les tarifs.
- Configurer les comptes : la visibilité intégrée avancée nécessite un compte de facturation basé aux États-Unis ainsi qu’au moins un compte d’expédition. Ces deux types de comptes sont mutuellement exclusifs. Seuls les administrateurs peuvent ajouter des comptes de facturation et d’expédition sur la page Gérer l’organisation.
Créez une URL de rappel valide dans votre application ou plateforme de destination – URL de votre application ou plateforme :
Vous devez utiliser HTTPS pour la sécurité.
Ne peut pas inclure l’espace d’adressage IP RFC1918, les sous-domaines de fedex.com, ou les adresses IP directes (p. ex., 127.0.0.1).
Générer un jeton de sécurité
Doit comporter 26 à 100 caractères et inclure :
- Une lettre majuscule
- Une lettre minuscule
- Un nombre
Exemple : Y1F6OiVUQW2JPSElmRE9U0IY5
Configurer la visibilité intégrée avancée
Choisissez la Visibilité intégrée avancée. Sélectionnez les fonctionnalités telles que la preuve de livraison, la livraison prévue, les événements de suivi et la filtration sur la base des événements.
Entrez votre URL de destination et votre jeton de sécurité.
Fournissez un courriel pour recevoir les mises à jour et les avis d’interruption concernant la visibilité intégrée avancée.
Confirmer les détails
Révisez et acceptez l’entente de licence du FedEx Developer Portal et le formulaire de commande.
Sélectionnez Créer pour finaliser la configuration.
Remarque : des étapes supplémentaires peuvent s’appliquer selon votre type d’abonnement. Consultez la documentation pour plus de détails.
Récupérer les identifiants de test et commencer les tests
Consultez la documentation de l’API
- Lisez la documentation sur les API pour comprendre les différentes API que nous proposons, ainsi que leur contexte commercial et les 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 d’accès souhaités.
Obtenez des 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.
Consultez la documentation de l’API
- Un jeton OAuth est requis pour toutes les transactions API et expire dans une heure.
- Votre application doit rafraîchir le jeton avant son expiration.
- Consultez la documentation sur API Authorization pour en savoir plus.
Testez les transactions API dans le bac à sable
- Accédez à l’API concernée dans le Catalogue API et sélectionnez Documentation.
- Sélectionnez le point d’accès API souhaité dans le menu de gauche.
- Utilisez des exemples de requêtes qui correspondent à votre cas d’utilisation.
- Implémentez des appels API en utilisant vos identifiants de test et les URL de test FedEx.
- Vérifiez les réponses par rapport à la documentation.
- Reportez-vous au Guide de virtualisation du bac à sable pour plus de détails.
Test de la visibilité intégrée avancée
Le test de visibilité intégrée avancée valide votre format URL et aide à établir une connexion entre FedEx et votre application.
Le test fournit des données d’exemple de test pour traiter les informations de suivi.
Remarque : les tests n’authentifient pas votre URL.
Consultez la documentation sur la visibilité intégrée avancée pour en savoir plus.
La validation est nécessaire pour déplacer les API en production. Le niveau de validation varie selon l’API.
Développez et testez les API de 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 (consultez la base de référence des cas de test pour intégrateurs).
- Avant d’exécuter les 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 à votre page Aperçu du projet.
Sélectionnez Demander des clés de production. FedEx recevra votre demande de clés de production et vous serez avisé une fois qu’elles seront approuvées.
Remplissez la feuille de couverture PIW et de validation
Remplissez la feuille d’information produit (PIW) et la feuille de couverture de validation de l’intégrateur avec vos coordonnées et les services FedEx prévus.
Soumettre les livrables
Collectez et compressez les éléments suivants dans un fichier.zip afin d’éviter les restrictions des fournisseurs de courriel. Envoyer à validationmtp@fedex.com.
Livrables requis
- PIW dûment rempli (PDF).
- Feuille de couverture de validation dûment remplie (PDF).
Captures d’écran (PDF) :
Votre solution destinée aux clients affichant les services FedEx/manutention spéciale
Déclaration d’avis de non responsabilité
Contrat de licence de l’utilisateur final
Flux d’inscription du client final
- Transactions d’inscription du client final avec authentification multifacteur (JSON)
- Étiquettes d’expédition numérisées pour tous les cas de test applicables (PDF/PNG)
- Expédier des transactions pour trois formats d’étiquettes : PDF, PNG, et ZPL (JSON) (pour les API d’expédition et de tarification applicables)
Meilleures pratiques pour éviter les retards
- Les étiquettes doivent être imprimées et balayées à une résolution minimale de 600 ppp.
- Les étiquettes des imprimantes thermiques doivent correspondre au modèle de l’imprimante (p. ex. ZPLII pour les imprimantes Zebra).
- Les envois FedEx International Express🅪 nécessitent une étiquette auxiliaire de lettre de transport aérien (LTA).
- Les envois multipièces doivent comprendre une étiquette pour chaque colis.
Évaluation des étiquettes
L’équipe de validation approuvera ou rejettera votre envoi.
- Si votre soumission est rejetée, apportez des corrections et soumettez-la de nouveau en fonction des commentaires.
- Si votre demande est approuvée, vous recevrez un courriel confirmant que la validation a été effectuée avec succès. Une fois que vous aurez reçu le courriel, vos identifiants de production seront autorisés pour les transactions d’étiquettes d’expédition.
Suivez les instructions post-validation
Révisez et mettez en œuvre les exigences post-validation, le cas échéant.
Une fois que vous avez été informé de l’approbation de vos clés de production, récupérez-les dans l’onglet Aperçu du projet.
- Copiez et stockez en toute sécurité votre clé API de production et votre clé secrète.
- La clé secrète n’est présentée qu’une seule fois—si vous la perdez, vous devez en régénérer une nouvelle.
