Discuter avec une API

Avec une longue période enfermé, dans ma propre maison, j’ai décidé de comuniquer avec deux API à l’aide de la documentation fourni (A défaut de parler avec mes chats ! ):

Afin de simuler une requête, l’outil postman sera donc utile pour faire les demandes aux API.

image Postman

Il existe plusieurs façons de s’authentifier on utilisera donc pour tester nos requêtes le Basic Auh (Cette méthode est la plus simple, mais également la moins sécurisée car elle transmet le mot de passe codé en base 64). Pour tester les requêtes cela suffira temporairement puis nous passerons sur de l’Oauh(Il permet d’autoriser un site web, un logiciel ou une application à utiliser l’API sécurisée d’un autre site web pour le compte d’un utilisateur).

On créé donc un personnel token sur Github et Azure Devops.


Exemple en image avec Github:

image token github

Puis on ajoute le token sur postman.

Exempple postman

Testons la requête qui permet de récupérer les répertoires publics de Github.

test requete postman

Une réponse 200 qui correspond au code de statut de réponse HTTP 200 OK qui indique la réussite d’une requête.


La difficulté est de construire nos requêtes avec la documentation pour récupérer :

  • Répertoire
  • Branche
  • commits

On a donc créé une collection sur postman pour enregistrer nos trouvailles.

Collection Postman

Chaque requête est donc documentée.

documentation postman

Afin qu’une autre personne puisse utiliser les paramètres de la requête, un lien vers la documentation de Github ou de Azure Devops est mis avec le retour de la requête.