COMMENT TESTER UNE API  ?

 

Prérequis

Avoir un compte.

 

Étape 1:  Se connecter au Dev Portal

 

  • Cliquez sur le bouton "Log in" dans le menu

 

 

  • Complétez les champs: Nom d'utilisateur et mot de passe

  • Cliquez sur le bouton "Connexion”
  • Complétez le code à usage unique généré sur votre mobile
  • Cliquez sur le bouton "Connexion

 


Étape 2: Création d'une app

Créez une app pour récupérer une Consumer Key un Consumer secret (si vous déjà une app vous pouvez copier vos credentials) 

  • Cliquez sur le bouton profil puis sur la page "My application"

 

 

  • Cliquez sur "Add app"

 

 

  • Complétez les champs: App Name, Callback URL, Description

 

 

Le champ Callback URL doit obligatoirement être renseigné avec la liste des urls de callbacks (séparés par ,) dans le cas où l’API est sécurisée en authorization code flow et pour le SSO

 

  • Sélectionnez les produits d’API auxquels vous voulez souscrire 

 

 

(Option) Dans le cas où l'application à laquelle vous souhaitez souscrire nécessite un certificat:

  • Sélectionnez vos certificats à joindre à "l'app"

 

  • Cliquez sur "Save" pour sauvegarder les modifications

 

L’écran suivant vous affiche la liste des vos « app »

 

Étape 3: Parcourir l'API catalog

  • Parcourez l'API catalog pour identifier l'API qui répond à vos besoins

 

 

  • Cliquez sur une API Card
  • Dans l'onglet "OAS DOC", vous pouvez trouver le Swagger

 

 

Étape 4: Authorize

  • Cliquez sur le bouton Authorize
  • Lorsque le jeton Oauth 2 est généré avec succès, le bouton passe de "Logout" à "Close"
  • L'UI va automatiquement ajouter le jeton bearer à l'en-tête d'autorisation
  • Sélectionnez votre App (dans la fenêtre pop-up)
 

La prochaine étape serait de tester l'API de Sandbox à partir de votre outil (exemple: Postman) pour tester votre API.

 

Remarque : Après l'étape 4, ce que vous renseignez dans l'en-tête de l'autorisation via l'UI ne sera pas pris en compte.
L'UI ajoute automatiquement le jeton bearer à l'en-tête d'autorisation pour vous.
 
 

Étape 4: Sélection de l'endpoint

 

  • Sélectionnez le endpoint que vous voulez tester
  • Cliquez sur le bouton "Essayer" pour le tester
  • Entrez les valeurs dans les en-têtes, en particulier les valeurs obligatoires avec un "* requis"
  • Cliquez sur le bouton "Exécuter"
  • Vérifiez les résultats de vos appels API