Préalables

Commencez votre intégration en tant que fournisseur FedEx Compatible en profitant des avantages offerts par les API FedEx. Les instructions suivantes vous guideront à travers chaque étape du processus d’extension des caractéristiques et des fonctionnalités de FedEx au sein de votre solution.


Étape 1 :

Parcourez les API pour déterminer celles dont vous aurez besoin pour votre application.

  • Accédez au Catalogue API pour déterminer les API qui conviennent à votre application.
  • Sélectionnez une API pour obtenir un aperçu et prendre connaissance de son journal des modifications et de ses principales caractéristiques.
Capture d’écran de la page Aperçu des tarifs
  • Consultez les documents de l’API pour en savoir plus sur les éléments de demande et de réponse, les exemples dans le langage de programmation de votre choix, les codes d’erreur, etc.
Capture d’écran de la page Documentation sur les tarifs
  • Consultez les annonces pour connaître les mises à jour prévues des services et les nouveautés.

Étape 2 :

Inscrivez-vous ou connectez-vous pour commencer à intégrer les API FedEx.

  • Connectez-vous à l’aide de votre ID utilisateur et de votre mot de passe sur fedex.ca pour commencer à intégrer les API FedEx.
  • Si vous n’avez pas encore d’ID utilisateur, veuillez vous inscrire gratuitement.

Étape 3 :

Joignez-vous à une organisation ou créez-en une.

Vous pouvez créer une organisation si elle n’existe pas encore pour votre entreprise ou vous joindre à l’organisation existante de votre entreprise. Plusieurs utilisateurs peuvent être associés à votre organisation, mais il n’est pas possible d’associer plusieurs organisations à un même ID d’utilisateur.

Si vous créez votre organisation, vous hériterez automatiquement du rôle d’administrateur de cette organisation. Un administrateur peut inviter des utilisateurs à se joindre à son organisation, leur attribuer des rôles et des projets et gérer les comptes d’expédition. Pour en savoir plus sur les rôles qui conviennent le mieux à chacun, consultez nos Lignes directrices sur l’administration des organisations. Pour créer votre propre organisation, cliquez sur Mes projets, puis sur le bouton « Créer une organisation ». Ce bouton s’affiche uniquement lorsque vous n’avez pas encore associé votre ID utilisateur à une organisation existante. Ensuite, vous pouvez commencer à créer une organisation en effectuant les étapes suivantes (celles marquées d’un * sont facultatives) :

  • Entrez un nom d’organisation.
  • Entrez les adresses courriel des membres de l’équipe que vous souhaitez inviter. Ils seront automatiquement ajoutés en tant qu’observateurs non associés à des projets*.
capture d’écran de la page Créer votre organisation

Vous pouvez également vous joindre à l’organisation de votre entreprise en procédant comme suit :

  • 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.
  • Pour accepter l’invitation, vous devrez soit vous connecter à l’aide de votre ID utilisateur et de votre mot de passe existants, soit créer de nouveaux identifiants si votre ID utilisateur existant est déjà associé à une organisation.

Étape 4 :

Ajoutez un compte d’expédition.

Un administrateur peut ajouter autant de comptes d’expédition que nécessaire dans l’organisation. Pour commencer, cliquez sur le bouton « Ajouter un compte » sous l’onglet Comptes d’expédition de la page Gérer l’organisation. Ensuite, vous pouvez ajouter un compte d’expédition existant à votre organisation en effectuant les étapes suivantes :

  1. Fournissez les renseignements sur le compte.
  • Entrez votre numéro de compte et le pseudonyme du compte, le cas échéant, de même que l’adresse de facturation associée au compte. Ces renseignements seront validés pour s’assurer qu’ils correspondent aux détails du compte et pour prévenir les activités frauduleuses.

  • Pour afficher les comptes d’expédition associés à votre ID utilisateur, accédez à la page Administration de l’expédition. Pour créer des comptes d’expédition, veuillez communiquer avec votre représentant commercial FedEx.

capture d’écran de la page Ajouter un compte d’expédition
  1. Contrat de licence de l'utilisateur final
capture d’écran de la page Signer le CLUF

Étape 5 :

Ajoutez des utilisateurs à votre organisation pour commencer à collaborer avec les membres de votre équipe.

Un administrateur peut inviter des utilisateurs à se joindre à son organisation et leur attribuer des rôles et des projets. Pour commencer, cliquez sur le bouton « Ajouter des utilisateurs » sous l’onglet Utilisateurs de la page Gérer de l’organisation. Ensuite, vous pouvez ajouter des utilisateurs en effectuant les étapes suivantes (celles marquées d’un * sont facultatives) :

  1. Entrez les adresses courriel du ou des utilisateurs qui doivent se joindre à votre organisation. Pour entrer plusieurs adresses courriel, appuyez sur les touches espace, virgule, point-virgule ou Entrée de votre clavier.
  2. Choisissez un rôle si l’option d’observateur par défaut ne correspond pas aux besoins d’un utilisateur*.
  3. Choisissez un projet associé à votre organisation pour y affecter des utilisateurs. Si vous n’en avez pas encore créé un, l’étape suivante vous indiquera la marche à suivre*.
capture d’écran de la page Ajouter des utilisateurs

Un administrateur aura toujours accès à tous les projets, mais un contributeur ou un observateur doit être affecté à un projet, sauf si le contributeur a créé le projet. Qu’un utilisateur ait déjà accepté l’invitation ou non, vous pouvez rapidement mettre à jour ses projets ou ses rôles directement depuis l’onglet Utilisateurs de la page Administration de l’organisation. Il vous suffit de cliquer sur le caret à côté du rôle ou du projet et un menu déroulant apparaîtra avec des options parmi lesquelles vous pourrez choisir. Faites votre choix et sélectionnez le bouton « Appliquer » pour enregistrer votre sélection.

capture d’écran de la page Gérer l’organisation

Étape 6 :

Créez un projet pour obtenir des identifiants.

Sur la page Mes projets, un administrateur ou un contributeur peut créer un projet en sélectionnant le bouton « Créer un projet ». Ensuite, il peut commencer à créer un projet en effectuant les étapes suivantes (celles marquées d’un * sont facultatives) :

1.  Configurer un projet        

  • Donnez à votre projet un nom identifiable et unique à votre organisation.
  • Commencez par sélectionner au moins une API à ajouter à votre projet. Vous pourrez toujours en ajouter ou en supprimer plus tard.           
capture d’écran de l’étape 1 de création d’un projet 

2. Accepter les conditions

capture d’écran de l’étape 2 de création d’un projet 
       
         3.  Configurer votre projet
 
  • Sélectionnez les pays dans lesquels vous prévoyez d’expédier, 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*.
  • Si vous prévoyez d’utiliser FedEx SmartPostMD Returns ou FedEx FreightMD LTL, sélectionnez Oui*.
  • Lorsque vous aurez cliqué sur le bouton « J’accepte », vous verrez apparaître une page de confirmation. Vous pouvez désormais afficher vos identifiants de test dans votre nouveau projet. 
capture d’écran de l’étape 3 de création d’un projet 

Étape 7 :

Intégrez les API dans votre application et testez votre implantation.

  1. Récupérez les identifiants de test (clé API, clé secrète et compte(s) d’expédition) sous l’onglet Clé de test de la page Aperçu du projet.
capture d’écran de la page Clés de test
  1. Demandez un jeton d’accès OAuth à utiliser avec 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.
  2. 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.
  3. Implantez vos appels vers ces terminaux comme il est décrit dans les exemples de requête, en les configurant pour utiliser vos identifiants de test.
  4. Vérifiez que les réponses aux appels API reçus correspondent à celles qui figurent dans la documentation.
  5. Testez entièrement votre implantation dans l’environnement de test FedEx en utilisant les identifiants de test et les URI de test FedEx.

Étape 8 :

Mettez votre projet en production.

Sur la page Aperçu du projet, cliquez sur l’onglet Clé de production. Ensuite, vous pouvez commencer à mettre votre projet en production en effectuant les étapes suivantes (celles marquées d’un * sont facultatives) :

  1. Configurez le projet.
  • Renommez votre clé API de production*.
  • Un seul compte d’expédition doit être ajouté à cette étape, mais vous pourrez en ajouter d’autres une fois que votre projet sera mis en production. Si vous n’avez pas de compte d’expédition associé à votre organisation ou si le CLUF n’a pas été signé pour les comptes d’expédition ajoutés à votre organisation, ces comptes n’apparaîtront pas dans le menu déroulant.
capture d’écran de l’étape 1 de la page Clés de production
  1. Obtenez les clés du projet.
  • Ensuite, 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.
  • 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.
capture d’écran de l’étape 2 de la page Clés de production

Étape 9 :

Terminez votre intégration.

  1. Certaines API nécessitent une certification de base ou 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.
capture d’écran de la page Certification
  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!


Étape 1 : 

FedEx crée une organisation de fournisseurs Compatible.

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

Étape 2 :

Acceptez l’invitation.

  • 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à.
capture d’écran de la page Inscrivez-vous pour commencer à intégrer les API FedEx

Étape 3 :

Invitez des utilisateurs dans votre organisation.

  • 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.
capture d’écran de la page Gérer les utilisateurs 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.

Étape 4 :

Sélectionnez les API dont vous avez besoin pour votre solution.

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

capture d’écran de la page Catalogue des API
  • Sélectionnez une API pour obtenir un aperçu et prendre connaissance de ses journaux de modifications et de ses principales caractéristiques.

capture d’écran de la page Aperçu de l’API de validation d’adresse
  • 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.

capture d’écran de la page Documentation sur l’API de validation d’adresse
  • Retournez dans Salesforce pour remplir la fiche d’information sur le produit et dresser la liste des API que vous souhaiteriez ajouter à votre solution.


Étape 5 :

FedEx crée le ou les projets.

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 Portail des développeurs FedEx. 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.


Étape 6 :

Intégrez les API dans votre application et obtenez la certification du programme Compatible.

  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.
capture d’écran de 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.
capture d’écran du menu déroulant des exemples de code « exemples » de la page API d’inscription au moyen d’identifiants
  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. Implantez vos appels vers 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.

Étape 7 :

FedEx met votre ou vos projets en production.

  • FedEx mettra ensuite votre ou vos projets en production.
  • Vous pourrez alors voir votre clé API de production sous l’onglet Production de la page Aperçu du projet.
capture d’écran de la version Compatible avec affichage du lien Générer pour l’onglet Production de la page Aperçu du projet

Étape 8 :

Générez la clé secrète de production.

  • 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!