API REST: Postman

 

Postman est une application qui vous permet de tester l’API d’une solution en envoyant des requêtes HTTP aux différentes ressources (fonctions) disponibles.

Très simple d’utilisation, vous aller rapidement pouvoir interagir avec l’API de votre compte Hiboutik.

 

1. Téléchargez l’application Postman : https://www.getpostman.com/postman

2. Récupérez vos identifiants Hiboutik d’accès à l’API dans « Paramètres/Utilisateurs/API » sur votre compte Hiboutik.

3. Sur Postman, cliquez sur « File » puis « Import », choisissez « Import from link » et indiquez dans la case prévue a cet effet le lien vers votre JSON API file (disponible dans « Paramètres/Utilisateurs/API »).
Cliquez sur Import.

4. Une fois l’import terminé, vous verrez apparaître dans la partie gauche une collection intitulée « Hiboutik Rest API ».
En bas a droite de l’intitulé, cliquez sur les trois petits points pour éditer (Edit) la collection puis cliquez sur la rubrique « Authorization ».

Dans type choisissez « Basic Auth » et dans la partie droite indiquez votre adresse email ainsi que la clé d’API récupérée sur Hiboutik.

5. Vous pouvez désormais tester les différentes ressources de l’API.

 

Ex : Ajoutons un client
Dans le menu de gauche, sélectionnez le dossier « Customers » et la ressource POST Create a new customer.
Dans la partie droite, allez dans la section Body et remplissez les différents champs. Puis cliquez sur le bouton Send.
Votre client est créé et prend l’identifiant qui s’affiche dans la section Body de la réponse.

Sachez que vous pouvez envoyer les datas de deux manières :
– application/json
– application/x-www-form-urlencoded
Avec Postman le plus simple étant d’utiliser x-www-form-urlencoded car les noms de variables sont déjà préremplis dans la section Body.

le hibou a écrit 81 articles