Requêter avec Postman

Appeler les API avec Postman

Il est tout à fait possible d'appeler les différentes API proposées à l'aide de l'outil Postman qui permet d'essayer les différentes requêtes possibles et de voir les réponses. Nous proposons des collections Postman sur nos API publiques pour simplifier la fabrication de vos requêtes.

Pour utiliser ces collections, vous devez vous créer un compte et une application vous permettant de requêter les API. Vous devez également avoir souscrit à l'API que vous souhaitez requêter. Vous pouvez ensuite envoyer des requêtes à cette API à l'aide de vos identifiants et vérifier les résultats.

 

Création d'une application et souscription à une API

Voir Souscrire à une API.

 

Création de l'environnement Postman

  • Installer Postman.
  • Télécharger le fichier de configuration de l'environnement.
  • Lancer Postman et cliquer sur le bouton Import. Sélectionner le fichier que vous venez de télécharger.
  • Sélectionner l'environnement "Emploi Store Développeurs Démo" au niveau de la liste située en haut à droite.

Conf_Environnement_Postman_1.png

  • Cliquer sur l'oeil situé à côté de la liste déroulante.

Configuration Environnement Postman 2.png

  • Cliquer sur "Edit".
  • Renseigner la colonne "current value" des variables "client_id" et "client_secret" avec ceux de votre application.

Configuration Environnement Postman 3.png

 

Importer une collection

Chaque API Publique propose un bouton "Run in Postman" vous permettant de télécharger un fichier à importer. Ce fichier créé une collection sur Postman avec des exemples de requêtes.

Pour importer une collection sur Postman :

  • Cliquer sur Import.
  • Sélectionner le fichier que vous avec téléchargé.
  • La collection importée s'affiche dans la partie gauche de Postman.

Configuration Environnement Postman 4.png

 

Envoyer une requête

Dès lors que vous avez configurer votre environnement et importer une collection, vous pouvez envoyer une requête à l'API.

Pour envoyer une requête via Postman :

  • Sélectionner la requête "1. Obtention d'un jeton" dans la collection qui a été importée.
  • Cliquer sur le bouton "Send".

Configuration Environnement Postman 5.png

  • Une variable d'environnement Postam est créée (nommée "token") afin de communiquer le jeton obtenu à la seconde requête.
  • Sélectionner la requête "2. Appel de l'API".
  • Cliquer sur le bouton "Send".
  • Le résultat de la requête apparaît dans la partie droite de Postman.

Configuration Environnement Postman 7.png

En cas d'erreur, vérifiez bien que les valeurs renseignées au niveau de la configuration de l'environnement (client_id et client_secret).