1. Créer un projet pour obtenir des identifiants
2. Intégrer les API et tester votre implantation
3. Mettre votre projet en production
4. Terminer 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 d’abord nous indiquer pourquoi vous avez besoin d’accéder aux API de FedEx. Une fenêtre modale apparaît et vous présente des options sous forme de menu déroulant. Vous devez sélectionner l’option qui correspond le mieux aux besoins de votre entreprise en matière d’intégration avec les API de FedEx.

Si vous vous identifiez comme expéditeur, vous pouvez commencer par créer votre projet. Il s’agit d’un processus en trois étapes :

Sélectionner des API

Sélectionnez la ou les API que vous souhaitez inclure dans votre projet. En fonction de la ou des API que vous avez sélectionnées, vous devrez peut-être effectuer des sélections supplémentaires.

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

• Sélectionner un numéro de compte à associer à votre clé de production.
• Passer en revue les quotas d’API de suivi, les limites de taux et les détails de certification de l’API.
• Choisir si vous souhaitez ou non recevoir des courriels qui vous informeront si vous dépassez votre quota de transactions.

Configurer le projet

Entrez quelques renseignements sur le projet, y compris le nom et le lieu d’expédition.

• 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/supprimer des pays ultérieurement.
• Pour recevoir des avis sur les dernières mises à jour des API et sur les renseignements relatifs aux pannes, vous pouvez définir vos préférences en matière d’avis.

Confirmer les détails

Passez en revue les détails de votre projet, puis acceptez les modalités.

• Lisez et acceptez le Contrat de licence du FedEx Developer Portal et reconnaissez que vous n’avez pas l’intention de vendre ou de distribuer votre application.
• Lorsque vous aurez cliqué sur le bouton « J’accepte », vous verrez apparaître une page de confirmation. Vous pouvez désormais voir vos références de test dans votre nouveau projet.

• Demander un jeton d’accès OAuth à utiliser avec 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 les documents d’autorisation API pour plus de détails
• Cliquez sur les documents relatifs à vos API pour lire le contexte commercial de chaque API afin de mieux comprendre comment l’utiliser. Vous pouvez également consulter des exemples de demandes pour le point de terminaison qui correspond à l’intégration souhaitée.
• Appliquez vos appels à ces points de terminaison comme il est décrit dans les exemples de demande, en les configurant avec vos identifiants de test.
• Vérifiez que les réponses à l’appel API que vous recevez correspondent à celles indiquées dans la documentation.
• Testez votre implantation dans l’environnement de test FedEx en utilisant les identifiants de test et les URL de test FedEx.

Pendant l’étape Configurer le projet :

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

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

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

Vous êtes alors renvoyé à la page Aperçu du projet. Ici, vous pouvez ajouter d’autres comptes associés à votre projet.

Sur la page Aperçu du projet :

• Cliquez sur les 3 points verticaux pour ajouter d’autres comptes associés à votre projet.
• Ensuite, cliquez sur Modifier.

Ceci vous amènera à la page Clé API, où vous pourrez ajouter tous 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 qui s’accompagnent de cette exigence.

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

2. Testez à nouveau votre implantation 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éer une URL valide dans votre application/plateforme de destination
2. Générer un jeton de sécurité
3. Tester l’URL du webhook
4. Valider l’URL de destination

Créer un projet webhook

1. Créer un projet webhook pour recevoir les avis sur la charge utile configurée

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

Créez une URL valide dans votre application/plateforme de destination pour recevoir des codes/messages d’authentification et des avis sur la charge utile du tracking webhook de la part de FedEx.

Exigences de l’URL :

Ce jeton de sécurité peut être utilisé comme clé secrète pour authentifier et valider les renseignements transmis entre vous (le client) et FedEx.

Exigences relatives aux jetons de sécurité :

• un minimum de 25 caractères et un maximum de 100 caractères
• 1 majuscule
• 1 minuscule
• 1 chiffre

Le test de votre URL est une étape facultative qui peut s’avérer utile.

Les tests peuvent vous aider à déterminer si l’URL que vous avez créée à l’étape 1 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.

En utilisant la méthode de l’algorithme de hachage HMAC SHA256, mettez en place un processus d’authentification pour valider les renseignements transmis entre votre URL de destination et FedEx.

1. Lorsque 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 demande. Vous devez à votre tour renvoyer cette chaîne de caractères à FedEx dans le corps de la réponse.

1. Initialisez le code d’authentification des messages (MAC) à l’aide de l’algorithme/de la procédure HMAC SHA256 pour hacher (ou combiner) la chaîne d’interrogation et le jeton de sécurité (ou la clé secrète) afin de former une signature de hachage

1. Renvoyez une réponse à FedEx contenant la challengeString et la challengeStringResponse dans le corps de la réponse, ainsi que le code d’état HTTP 200 (OK) ou 202 (ACCEPTÉ).

1. FedEx validera alors la chaîne d’interrogation et la réponse à la chaîne d’interrogation.

• Une fois que FedEx a reçu le corps de la réponse, il valide la challengeString et la challengeStringResponse (ou la signature de hachage générée précédemment) en les comparant respectivement à la challengeString et à la signature de hachage générées par FedEx.

• Si la « challengeString » et les signatures HMAC correspondent, la validation et le flux de travail sont réussis. Dans le cas contraire, le processus de validation échouera et un message d’erreur s’affichera.

Créer un projet webhook

Sur la page Mes projets, accédez à 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 d’abord nous indiquer pourquoi vous avez besoin d’accéder aux webhooks de FedEx. Une fenêtre modale apparaît et vous présente des options sous forme de menu déroulant. Vous devez sélectionner l’option qui correspond le mieux aux besoins de votre entreprise en matière d’intégration avec les webhooks de FedEx.

Si vous vous identifiez comme expéditeur, vous pouvez commencer à créer votre projet en suivant les étapes suivantes :

1. Identifiez les besoins de votre entreprise

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

1. Sélectionnez le niveau et les caractéristiques du niveau

• Sélectionnez un niveau de webhook de base ou avancé pour votre projet, en fonction de vos besoins.
• Vous pouvez toujours modifier votre choix de niveau ultérieurement.
• Chaque niveau est associé à un abonnement mensuel.

• Sélectionnez les caractéristiques que vous souhaitez configurer avec votre projet.
• Vous pouvez également modifier votre choix de caractéristiques ultérieurement.

1. Configurez les détails du projet

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

Choisir des comptes

• Choisissez parmi une liste de numéros de compte admissibles (basés aux États-Unis ou au Canada) ceux que vous souhaitez associer à votre projet.

  5.Confirmer les détails et acceptez les conditions

• Passez en revue les détails configurés de votre projet.
• 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 l’Accord de tarification.
• Une fois que vous avez 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’affichera.

• Si la validation n’est pas réussie ou échoue, un message d’erreur s’affichera.

1. Votre projet de tracking webhook aura alors un ID de webhook généré par le système et sera indiqué comme étant à l’état « 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 à se joindre à l’organisation. Cet utilisateur sera désigné comme étant l’administrateur au sein 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 à l’aide de votre ID utilisateur et de votre mot de passe FedEx, soit créer de nouveaux identifiants si vous n’en avez pas déjà.

• 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 obtenir un complément d’information sur les différents rôles, consultez le Guide d’administration de l’organisation.

• Si votre organisation est déjà créée, demandez à l’administrateur de l’organisation ou à FedEx 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.

• Visitez le Catalogue 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 obtenir un aperçu et prendre connaissance de ses journaux de modifications et de ses principales caractéristiques.

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

• Retournez dans Salesforce pour remplir la fiche d’information sur le produit et dresser la liste des API que vous souhaiteriez ajouter à votre solution.

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 au sein du FedEx Developer Portal. Si un utilisateur n’est pas un administrateur de l’organisation, il aura besoin d’une invitation pour consulter chacun des projets. 

C’est aussi à cette étape que l’équipe FedEx Compatible, conjointement avec les équipes de certification et le consultant en technologies clients FedEx, organisera 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. Elle 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 alors accès à votre clé API de test et à votre clé secrète de test pour commencer à effectuer des transactions. Récupérez-les sous l’onglet Clé de test de la page Aperçu du projet.

1. Pour créer des clés de client, vous devrez utiliser l’API d’inscription au moyen d’identifiants, une API privée uniquement disponible dans la section API de chacun de vos projets.
2. Lorsque vous aurez créé quelques clés de client, demandez un jeton d’accès OAuth qui sera utilisé lors de chaque transaction API. Comme la session pour 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 les documents d’autorisation API pour plus de détails. Lors de l’affichage des exemples de code, assurez-vous que l’entrée « Revendeur » est choisie dans le menu déroulant des exemples.

1. Sélectionnez les documents relatifs aux API sur votre page Clés de test et lisez le contexte commercial 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. Appliquez vos appels à ces terminaux comme il est décrit dans les exemples de requête, en les configurant pour utiliser vos identifiants de test.
3. Vérifiez que les réponses aux appels API reçus correspondent à celles qui figurent dans la documentation.
4. Testez entièrement votre implantation dans l’environnement de test FedEx en utilisant les identifiants 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!