Expéditeur FedEx
Prérequis
Vous devez posséder un ID d’utilisateur FedEx pour vous connecter au FedEx Developer Portal et créer une organisation.
Rejoignez l’organisation de votre entreprise pour collaborer avec votre équipe. Si votre entreprise n’a pas d’organisation, vous pouvez en créer une.
Rejoindre une organisation existante
1. Demander une invitation
Demandez à l’administrateur de votre organisation de vous envoyer une invitation. Vous avez 24 heures pour l’accepter. Si l’invitation expire, demandez à l’administrateur de la renvoyer.
2. Accepter l’invitation
Connectez-vous avec votre ID d’utilisateur et votre mot de passe. Si votre ID d’utilisateur est lié à une autre organisation, créez-en un nouveau.
Créer une organisation
Lorsque vous créez une organisation, vous en devenez l’administrateur. En tant qu’administrateur, vous pouvez inviter des utilisateurs à rejoindre l’organisation, leur attribuer des projets et des rôles utilisateur, et gérer les comptes d’expédition.
Pour en savoir plus sur les rôles utilisateur, consultez les conseils sur l’administration des organisations.
1. Connectez-vous au FedEx Developer Portal.
2. Dans le menu, sélectionnez Mes projets, puis sélectionnez Créer une organisation.
3. Saisissez les informations suivantes :
- Pour Je travaille pour une entreprise qui, sélectionnez Expédie avec FedEx et qui a besoin d’intégrer les API FedEx à ses propres applications.
- Saisissez le nom de votre entreprise, son site Web ainsi qu’un nom d’organisation que votre équipe reconnaîtra, comme le nom de votre société, d’un service, d’une division ou d’une région.
4. Sélectionnez Créer.
Vous pourrez mettre à jour ou ajouter des détails plus tard via l’onglet Gérer l’organisation dans le menu.
Ajouter un compte d’expédition
1. Sélectionnez Ajouter des comptes d’expédition dans la section Ajouter des comptes. Si vous n’avez pas de compte FedEx, sélectionnez Créer un compte pour en ouvrir un nouveau ou contactez l’assistance FedEx.
2. Sélectionnez + Ajouter un compte.
3. Saisissez votre numéro de compte FedEx, l’alias du compte et l’adresse de facturation associée au compte.
4. Acceptez le Contrat de licence de l’utilisateur final ou transférez-le à un représentant autorisé de votre entreprise.
Ajouter un compte de facturation
1. Sélectionnez l’onglet Comptes de facturation. Si vous n’avez pas de compte de facturation FedEx, sélectionnez Ouvrir un compte de facturation ou contactez l’assistance FedEx.
2. Sélectionnez Ajouter un compte de facturation. Les comptes de facturation doivent être basés aux États-Unis.
3. Saisissez votre numéro de compte FedEx, l’alias du compte et l’adresse de facturation située aux États-Unis associée au compte.
4. Lisez et acceptez le Contrat de licence de l’utilisateur final.
Inviter des utilisateurs en tant qu’administrateurs
1. Dans le menu, sélectionnez Gérer l’organisation, puis sélectionnez l’onglet Utilisateurs.
2. Sélectionnez + Ajouter des utilisateurs.
3. Sélectionnez un pays ou territoire et une langue de préférence, puis choisissez un rôle utilisateur : lecteur, contributeur ou administrateur.
4. (Facultatif) Attribuez l’utilisateur à un projet. Vous pouvez attribuer des utilisateurs à tout moment depuis la page Aperçu du projet.
5. Saisissez les adresses e-mail des utilisateurs et cliquez sur Inviter. Vous pouvez inviter jusqu’à 20 utilisateurs à la fois, en séparant chaque adresse e-mail par une virgule. Les invitations expirent après 24 heures.
Créer un projet API
1. Dans le menu, sélectionnez Mes projets, puis cliquez sur l’onglet API et choisissez + Créer un projet API.
2. Confirmez vos besoins en matière d’API.
3. Sélectionnez les API à inclure dans votre projet.
4. Créez un nom de projet et sélectionnez les pays vers lesquels vous prévoyez d’expédier pour recevoir un compte d’expédition de test. Pour les envois domestiques en Europe, vous devez disposer d’un compte de test distinct pour chaque pays. Vous pouvez ajouter ou retirer des pays ultérieurement.
5. Sélectionnez Paramètres sous Notifications pour définir vos préférences en matière de notifications.
6. Lisez et acceptez les conditions générales.
Créer un projet Advanced Integrated Visibility
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 Shipment 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.
1. Créez une URL de destination dans votre application ou plateforme pour recevoir les rappels. L’URL doit :
- Utiliser le protocole HTTPS ;
- Exclure l’espace d’adressage IP RFC1918, le domaine fedex.com et ses sous-domaines, ainsi que les adresses IP de type localhost ou 127.0.0.1.
2. Générez un jeton de sécurité pour vous authentifier. Le jeton doit :
- Contenir entre 26 et 100 caractères, au moins une lettre majuscule, une lettre minuscule et un chiffre.
3. Dans le menu, cliquez sur Mes projets, puis sélectionnez l’onglet Advanced Integrated Visibility.
4. Sélectionnez Créer un projet Advanced Integrated Visibility.
5. Sélectionnez le type d’utilisateur.
- Expéditeur FedEx : expédie avec FedEx et doit intégrer les API FedEx dans ses propres applications
- Fournisseur FedEx Compatible : est un fournisseur FedEx Compatible
- Fournisseur Intégrateur FedEx : vend ou propose une solution logicielle basée sur une technologie FedEx, et est un Fournisseur FedEx Intégrateur validé
6. Sélectionnez le type d’abonnement. Vous pouvez vous abonner aux événements via les numéros de compte ou les numéros de suivi.
7. Confirmez le compte de facturation et sélectionnez les fonctionnalités désirées, telles que la preuve de livraison, la livraison estimée, les événements de suivi ou le filtrage basé sur les événements.
8. Saisissez les informations de projet.
- Saisissez un nom de projet unique et reconnaissable.
- Saisissez l’URL de destination et le jeton de sécurité que vous avez créés.
- Saisissez une adresse e-mail et une langue de préférence pour recevoir les notifications concernant les mises à jour et les interruptions de service d’Advanced Integrated Visibility.
9. Acceptez le Contrat de licence du FedEx Developer Portal ainsi que le formulaire de commande et cliquez sur Créer.
Remarque : selon le type d’abonnement choisi, des étapes supplémentaires peuvent être nécessaires. Pour plus d’informations, voir la documentation du webhook.
Suivez ces étapes pour vérifier votre intégration API et confirmer que votre application peut envoyer et recevoir des données de test.
Récupération des identifiants de test
1. Dans le menu, cliquez sur Mes projets, puis sélectionnez l’onglet Nom du projet.
2. Dans l’onglet Clés API, sous Clé de test, trouvez vos identifiants de test.
3. Connectez-vous et téléchargez la collection d’API JSON via le bouton Télécharger le schéma JSON situé en haut de la page de documentation. Examinez les exemples de requêtes pour les points de terminaison utilisés par votre intégration.
4. Demandez un jeton d’accès OAuth à utiliser avec chaque transaction API.
Remarque : le jeton est valide pendant une heure. Vous pouvez configurer votre application pour le renouveler avant son expiration. Pour plus d’informations, consultez la documentation sur l’API Authorization.
5. Dans le menu, sélectionnez Catalogue d’API, choisissez l’API avec laquelle vous souhaitez travailler, puis sélectionnez Documentation.
6. Dans le menu, sélectionnez le point de terminaison.
7. Envoyez des requêtes d’exemple en utilisant vos identifiants de test et l’URL de test de FedEx, puis confirmez que les réponses correspondent aux exemples de la documentation. Pour plus de détails, consultez le Guide de virtualisation Sandbox.
8. Effectuez des tests avec Advanced Integrated Visibility pour générer des données d’exemple et confirmer que votre application traite correctement les informations de suivi.
Remarque : ce test ne permet pas d’authentifier votre adresse URL de rappel. Pour plus d’informations, consultez la documentation sur Advanced Integrated Visibility.
Mettre votre projet en production
Configurez vos paramètres de production avant la mise en service. Vous pouvez renommer la clé, ajouter des comptes supplémentaires après la mise en service du projet et consulter le numéro de compte sélectionné lors de la création du projet. Ce numéro de compte fait passer votre projet en production.
Remarque : les projets Advanced Integrated Visibility basés sur le numéro de compte ne nécessitent pas d’activation en production.
1. Dans le menu, cliquez sur Mes projets, puis sélectionnez l’onglet Nom du projet.
2. Sélectionnez l’onglet Clé de production.
3. Récupérez et stockez vos identifiants de production en toute sécurité.
- Copiez la clé API de production et la clé secrète dans un emplacement sécurisé.
- Lorsque vous demandez une clé de production, enregistrez-la dans un emplacement sécurisé, car elle ne s’affiche qu’une seule fois. Si vous la perdez, vous pourrez en générer une nouvelle ultérieurement.
4. Sélectionnez Suivant pour consulter les informations de votre projet dans l’onglet Clé de production.
Pour ajouter plus de comptes d’expédition, 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.
Valider votre API
Certaines API FedEx nécessitent une validation d’étiquette d’expédition avant de pouvoir être utilisées en production. Consultez les exigences de validation de l’API avant de commencer.
1. Dans le menu, cliquez sur Mes projets, puis sélectionnez l’onglet Nom du projet.
2. Dans l’onglet Clés API, sous Clé de test, recherchez vos identifiants de test.
3. Une fois les tests terminés, passez votre projet en production dans FedEx Developer Portal pour commencer la validation.
- Lorsque vous demandez une clé de production, enregistrez-la dans un emplacement sécurisé, car elle ne s’affiche qu’une seule fois. Si vous la perdez, vous pourrez en générer une nouvelle ultérieurement.
4. Fournissez les informations requises sur la page de garde de l’étiquette, notamment vos coordonnées, les services que vous prévoyez de mettre en œuvre, votre numéro de compte et votre clé API de production.
5. Créez des étiquettes de test dans l’environnement de test FedEx, puis soumettez-les au groupe d’analyse des codes-barres de FedEx. Prévoyez trois jours ouvrables pour l’évaluation des étiquettes.
Bonnes pratiques pour éviter les retards :
- Imprimez et scannez les étiquettes à une résolution minimum de 600 DPI. Ne soumettez pas de fichiers générés directement par les API.
- Pour les imprimantes thermiques, demandez le type d’image qui correspond à votre imprimante, par exemple ZPLII pour les imprimantes Zebra.
- Utilisez des adresses d’expéditeur et de destinataire valides pour vos étiquettes d’exemple. Créez des étiquettes uniquement pour les services que vous prévoyez d’utiliser.
- Pour la livraison contre remboursement FedEx (CR), incluez l’étiquette de retour CR.
- Pour FedEx International Express®, incluez le bordereau d’expédition auxiliaire/secondaire.
- Pour les envois multicolis (MPS), soumettez une étiquette pour chaque colis.
Envoyez vos ressources à l’aide d’une des options suivantes :
- Envoyez le PDF et la page de garde de l’étiquette par e-mail à l’adresse label@fedex.com.
- Envoyez les étiquettes physiques par courrier à :
Services FedEx
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Remarque : pour les étiquettes physiques, assurez-vous qu’elles ne présentent aucun défaut visible, comme des traces d’encre ou des dommages. N’agrandissez pas et ne rétrécissez pas les étiquettes lors de l’impression.
6. Le groupe d’analyse des codes-barres de FedEx examine votre soumission et approuve ou rejette les étiquettes. Si les étiquettes sont rejetées, tenez compte des remarques et soumettez-les à nouveau.
7. Après approbation, le groupe d’analyse des codes-barres de FedEx vous enverra un e-mail une fois vos identifiants de production autorisés pour les transactions d’étiquettes d’expédition.
Remarque : l’approbation s’applique par projet. Chaque nouveau projet nécessite une approbation.
8. Remplacez les URL et identifiants de test par vos URL et identifiants de production.
9. Remplacez les URL et identifiants de test par vos URL et identifiants de production.
