Commencer à utiliser Postman avec l'API Discourse

[supermathie (Michael Brown)]

Résumé

Postman est un moyen de construire et de tester facilement des requêtes auprès d’une API.

Configuration avec Discourse

1. Après avoir ouvert Postman, cliquez sur Create Workspace :

   

2. Choisissez Blank workspace et cliquez sur Next.

3. Nommez-le Discourse API et sélectionnez Create :

   

4. Cliquez sur Collections :
   

   

5. Cliquez sur Import :
   

   

6. Collez https://docs.discourse.org/openapi.json (qui est l’URL de « Téléchargement » affichée sur docs.discourse.org) :
   

   

7. Choisissez d’importer en tant que Postman Collection :
   

   

Créer un nouvel environnement

1. Cliquez sur Environments et Create Environment. Ceci contiendra les variables spécifiques à l’instance que vous testez. Pour cet exemple, nous utiliserons try.discourse.org.

   • ajoutez une nouvelle variable : defaultHost avec la valeur try.discourse.org :
   • sélectionnez l’environnement try.discourse.org dans le menu déroulant ⑤ Environment
   

Hello World !

Essayons une requête !

1. Sélectionnez Collections → categories.json → Retrieves a list of categories et cliquez sur Send. Vous devriez voir le résultat :
   
   

Ajouter l’authentification aux requêtes

Pour utiliser l’API avec l’authentification par clé API :

1. Ajoutez les variables suivantes à cet environnement ou à un nouvel environnement :

   • api-username
   • api-key
   
   
   (leurs valeurs doivent bien sûr être valides pour le site que vous interrogez)

2. Ajoutez un script à la collection
   Sélectionnez Collections → Discourse API Documentation → Scripts → Pre-request et collez le code suivant :

   pm.request.headers.add({
       key: "api-key",
       value: pm.variables.get("api-key")
   })
   pm.request.headers.add({
       key: "api-username",
       value: pm.variables.get("api-username")
   })