1. Créez un projet pour obtenir des informations d’identification
2. Intégrez les API et testez votre mise en œuvre
3. Mettez votre projet en production
4. Complétez votre certification

Un administrateur ou un contributeur de votre organisation peut créer un projet API en cliquant sur le bouton Créer un projet API.

Avant de commencer, vous devez préciser pour quelle raison vous avez besoin d’accéder aux API de FedEx. Une fenêtre modale apparaît et vous présente des options dans une liste déroulante. Sélectionnez l’option correspondant le mieux à la raison pour laquelle votre entreprise souhaite intégrer les API FedEx.

Si vous vous identifiez en tant qu’expéditeur, vous pouvez commencer à créer votre projet. Ce processus se déroule en trois étapes :

Sélectionner des API

Sélectionnez la ou les API que vous souhaitez inclure dans votre projet. Selon l’API que vous choisissez, il se peut que vous deviez faire des sélections supplémentaires.

Si vous sélectionnez l’API de suivi, vous devrez également :

• Sélectionner un numéro de compte associé à votre clé de production ;
• Vérifier les quotas d’API, les limites de taux et les détails de la certification API ;
• Choisir de recevoir ou non les e-mails vous informant du dépassement de votre quota de transactions.

Configurer le projet

Saisissez quelques informations sur le projet, telles que le nom et le lieu d’expédition.

• Attribuez à votre projet un nom identifiable et unique pour votre organisation.
• Sélectionnez les pays dans lesquels vous prévoyez de livrer, 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, vous pouvez configurer vos préférences de notification.

Confirmez les détails

Passez en revue les détails de votre projet, puis acceptez les Conditions générales.

• Lisez et acceptez le Contrat de licence FedEx Developer Portal, et reconnaissez que vous n’avez pas l’intention de vendre ni de distribuer votre application.
• Dès que vous avez cliqué sur le bouton « Créer », un écran de confirmation apparaît. Vous pouvez alors afficher vos informations d’identification de test dans votre nouveau projet.

• Demandez un jeton d’accès OAuth, qui 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 de détails, reportez-vous aux documents d’autorisation d’API.
• Cliquez sur les documents relatifs à vos API et lisez le contexte métier de chacune des API pour mieux comprendre comment utiliser celles-ci. Vous pouvez également passer en revue les exemples de requête du terminal qui correspondent à l’intégration de votre choix.
• Implémentez vos appels vers ces terminaux comme décrit dans les exemples de requête, en les configurant d’après vos informations d’identification de test.
• Vérifiez que les réponses aux appels d’API reçus correspondent à celles qui figurent dans la documentation.
• Testez votre implémentation dans l’environnement de test FedEx en utilisant les informations d’identification et l’URL de test FedEx appropriées.

Durant l’étape Configurer le projet :

• Vous pouvez renommer 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.

Durant l’étape Obtenir les clés du projet :

• Votre clé API de production et votre clé secrète de production seront affichées. Assurez-vous de les copier dans un endroit sûr.
• 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.
• Cliquez sur Suivant.

Vous allez à présent être redirigé vers la page Aperçu du projet. De là, vous pouvez ajouter d’autres comptes associés à votre projet.

Sur la page Aperçu du projet :

• Cliquez sur les 3 points verticaux (ou sur le menu kebab) pour ajouter d’autres comptes associés à votre projet.
• Puis, cliquez sur Modifier.

Vous accédez à la page Clé API, dans laquelle vous pouvez ajouter les comptes supplémentaires que vous souhaitez associer à votre clé de production pour ce projet.

1. Certaines API nécessitent une certification d’étiquette d’expédition pour pouvoir être utilisées dans notre environnement de production. Effectuez le processus de certification pour toutes les API de votre projet avec cette exigence.

1. Une fois que toutes les API ont été certifiées et activées, mettez à jour vos requêtes d’API en remplaçant les URI, les clés et les comptes d’expédition de test par ceux de l’environnement de production.

2. Testez à nouveau votre implémentation dans l’environnement de production en utilisant des exemples de données.

3. Profitez des avantages de votre nouvelle intégration.

Conditions préalables à la création d’un projet webhook

1. Créez une URL valide dans votre application ou plateforme de destination
2. Générez un jeton de sécurité
3. Testez l’URL webhook
4. Validez l’URL de destination

Créez un projet webhook

1. Créez un projet webhook pour recevoir des notifications sur la charge utile configurée.

Conditions préalables à la création d’un projet webhook

Créez une URL valide dans votre application ou plateforme de destination afin de recevoir les codes ou messages d’authentification et les notifications de charge utile du Tracking Webhook de la part de FedEx.

Exigences concernant l’adresse URL :

Ce jeton de sécurité peut être utilisé en tant que clé secrète afin d’authentifier et valider les informations transmises entre vous (le client) et FedEx.

Exigences applicables au jeton de sécurité :

• Longueur compris entre 25 et 100 caractères
• 1 majuscule
• 1 minuscule
• 1 caractère numérique

La mise à l’essai de votre URL est une étape facultative, mais qui peut s’avérer utile.

Ce test peut vous permettre de déterminer si l’URL que vous avez créée à l’étape 1 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.

En appliquant la méthode de l’algorithme de hachage HMAC SHA256, configurez un processus d’authentification destiné à valider les informations transmises entre votre URL de destination et FedEx.

1. Au moment où vous cliquez sur Créer, FedEx génère une chaîne de caractères aléatoire qui vous est envoyée dans le corps de la requête.Vous devrez renvoyer à votre tour cette chaîne de challenge à FedEx dans le corps de la réponse.

1. Initialisez le code d’authentification des messages (MAC) en utilisant l’algorithme ou la procédure HMAC SHA256 de manière à hacher (ou combiner) la chaîne de challenge et le jeton de sécurité (ou la clé secrète) et générer une signature de hachage.

1. Répondez à FedEx en renvoyant les chaînes challengeString et challengeStringResponse ensemble dans le corps de la réponse, accompagnées du code d’état HTTP 200 (OK) ou 202 (ACCEPTÉ).

1. FedEx valide ensuite la chaîne de challenge et la réponse correspondante.

• Après réception du corps de la réponse, FedEx valide la chaîne de challenge et la réponse à celle-ci (ou la signature de hachage générée précédemment), en les comparant respectivement à la chaîne challengeString et à la signature de hachage générées par FedEx.

• Si la chaîne « challengeString » et les signatures HMAC correspondent, la validation et le flux de traitement aboutissent.Dans le cas contraire, le processus de validation échoue et un message d’erreur s’affiche.

Créez un projet webhook

Sur la page Mes projets, ouvrez l’onglet Webhooks.

Un administrateur ou un contributeur de votre organisation peut créer un projet webhook en cliquant sur le bouton Créer un projet webhook.

Avant de commencer, vous devez préciser pour quelle raison vous avez besoin d’accéder aux webhooks de FedEx. Une fenêtre modale apparaît et vous présente des options dans une liste déroulante. Sélectionnez l’option correspondant le mieux à la raison pour laquelle votre entreprise souhaite intégrer les webhooks FedEx.

Si vous vous identifiez en tant qu’expéditeur, vous pouvez commencer à créer votre projet en procédant comme suit :

1. Identifiez les besoins de votre activité

• Sélectionnez l’option correspondant le mieux à la raison pour laquelle votre entreprise souhaite intégrer les webhooks FedEx.

1. Sélectionnez un niveau et des fonctionnalités de niveau

• Sélectionnez un niveau de webhook basique ou avancé pour votre projet, suivant vos besoins.
• Vous pourrez toujours modifier votre choix de niveau ultérieurement.
• Chaque niveau est assorti de frais d’abonnement mensuels.

• Sélectionnez les fonctionnalités que vous souhaitez configurer dans votre projet.
• Vous pourrez toujours modifier vos fonctionnalités ultérieurement.

1. Configurez les détails du projet

• Attribuez un nom identifiable à votre projet
• Fournissez l’URL de destination pré-générée et les détails du jeton de sécurité, qui sont créés lors de l’authentification pré-configurée.

Choisissez les comptes

• Choisissez parmi une liste de numéros de compte éligibles (situés aux États-Unis ou au Canada) à associer à votre projet.

  5. Confirmez les détails et acceptez les conditions

• Passez en revue les détails du projet que vous avez configuré.
• Lisez et acceptez le Contrat de licence du Developer Portal, et reconnaissez que vous n’avez pas l’intention de distribuer votre application.
• Lisez et acceptez le Contrat de tarification.
• Après avoir cliqué sur le bouton Créer un projet :

1. Si votre demande de création a été validée et traitée avec succès, un écran de confirmation s’affiche.

• Si la validation échoue, un message d’erreur s’affiche.

1. Votre projet Tracking Webhook se voit alors attribuer un identifiant généré par le système avec le statut « actif ».

1. FedEx crée une organisation de fournisseurs Compatible.
2. Acceptez l’invitation.
3. Invitez des utilisateurs dans votre organisation.
4. Sélectionnez les API dont vous avez besoin pour votre solution.
5. FedEx crée le ou les projets.
6. Intégrez les API dans votre application et obtenez la certification du programme Compatible.
7. FedEx met votre ou vos projets en production.
8. Générez la clé secrète de production.

• 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.
• Une fois la certification et l’intégration terminées, vous pourrez distribuer la solution à vos clients en toute simplicité.

• Afin d’avoir accès à la documentation et aux artefacts d’intégration de l’API, veuillez accepter l’invitation. Pour accepter l’invitation, vous devrez soit vous connecter avec votre ID d’utilisateur FedEx et votre mot de passe, soit en créer un nouveau si vous n’avez pas encore d’informations d’identification.

• En tant qu’administrateur, vous pouvez inviter tous les membres de l’équipe qui ont besoin d’accéder au projet ou à l’organisation. Pour plus d’informations sur les différents rôles, consultez le Guide d’administration de l’organisation.

• Si votre organisation a déjà été créée, demandez à l’administrateur de l’organisation ou à FedEx de vous inviter à la rejoindre. Vous aurez 24 heures pour accepter son invitation. Si vous dépassez ce délai, vous pouvez lui demander de la renvoyer.

• Consultez le catalogue d’API pour déterminer les API adaptées à 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.

• Sélectionnez une API pour découvrir sa présentation, ses journaux des modifications et ses principales caractéristiques.

• Consultez la documentation de l’API pour en savoir plus sur les éléments de requête et de réponse, les exemples dans le langage de votre choix, les objets d’erreur, etc.

• Retournez dans Salesforce pour remplir la fiche d’informations produit (FIP) et dresser la liste des API que vous souhaiteriez ajouter à votre solution.

Une fois la FIP approuvée, FedEx créera votre ou vos projets. Chaque version de chacune de vos solutions aura un projet distinct au sein du Fedex Developer Portal. Si un utilisateur n’est pas un administrateur de l’organisation, il aura besoin d’une invitation pour pouvoir consulter chaque projet. 

C’est aussi à cette étape que l’équipe FedEx Compatible, conjointement avec les équipes de certification et le consultant en technologies clients FedEx, organise une démonstration technique des API avec votre équipe. L’équipe FedEx discutera des nouvelles caractéristiques et fonctionnalités disponibles avec la version des API que vous adoptez. L’équipe sera en mesure de répondre aux questions techniques concernant les API, les tests d’API et toutes les procédures à suivre pour lancer le processus de « certification* » des API.

* Certification – Le processus défini par le programme FedEx Compatible pour satisfaire aux exigences de conformité du programme. La certification du programme Compatible est nécessaire pour garantir que tous les fournisseurs Compatible mettent en œuvre, commercialisent et distribuent la technologie FedEx aux expéditeurs (clients) conformément aux normes FedEx en matière de technologie et de service.

1. Vous aurez maintenant accès à votre clé API de test et à votre clé secrète de test pour commencer à effectuer des opérations. Récupérez-les dans l’onglet Clé de test de la page Aperçu du projet.

1. Pour créer des clés client, vous devrez utiliser l’API d’enregistrement des informations d’identification, qui est une API privée se trouvant uniquement dans la section API de chacun de vos projets.
2. Une fois que vous avez créé quelques clés client, demandez un jeton d’accès OAuth qui sera utilisé lors de chaque opération API. La session pour le jeton n’est valable que pendant une heure, vous devrez donc coder votre application par programme pour actualiser le jeton avant l’expiration de la session. Consultez les documents d’autorisation API pour plus de détails. Lors de l’affichage des exemples de code, assurez-vous que le « Revendeur » est choisi dans la liste déroulante des exemples.

1. Sélectionnez les documents relatifs aux API sur votre page Clés de test et lisez le contexte métier pour mieux comprendre comment utiliser l’API sélectionnée. Passez en revue les exemples de requête du terminal qui correspondent à l’intégration de votre choix.
2. Implémentez vos appels vers ces terminaux comme décrit dans les exemples de requête, en les configurant pour utiliser vos informations d’identification de test.
3. Vérifiez que les réponses aux appels API reçus correspondent à celles qui figurent dans la documentation.
4. Testez complètement votre implémentation dans l’environnement test FedEx en utilisant les informations d’identification de test et les URI de test FedEx.
5. Après avoir entièrement testé vos solutions, certifiez chacune d’elles dans Salesforce. FedEx examinera en détail tout ce qui a été soumis et vous informera dès que votre certification sera approuvée.

• FedEx mettra ensuite votre ou vos projets en production.
• Vous pourrez alors voir votre clé API de production sous l’onglet Clé de production de la page Aperçu du projet.

• Pour générer votre clé secrète de production, cliquez sur le lien Générer la clé secrète dans 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.
• Profitez des avantages de votre nouvelle intégration.