Comenzando a usar Postman con la API de Discourse

[supermathie (Michael Brown)]

Resumen

Postman es una forma de construir y probar fácilmente solicitudes contra una API.

Configuración con Discourse

1. Después de abrir Postman, haz clic en Crear Workspace:

   

2. Elige Blank workspace y haz clic en Next.

3. Asígnale el título Discourse API y selecciona Create:

   

4. Haz clic en Collections:
   

   

5. Haz clic en Import:
   

   

6. Pega https://docs.discourse.org/openapi.json (que es la URL de “Download” que se muestra en docs.discourse.org):
   

   

7. Elige importar como Postman Collection:
   

   

Crear un nuevo Entorno

1. Haz clic en Environments y Create Environment. Esto contendrá variables específicas de la instancia que estás probando. Para este ejemplo, usaremos try.discourse.org.

   • agrega una nueva variable: defaultHost con el valor try.discourse.org:
   • selecciona el entorno try.discourse.org del menú desplegable ⑤ Environment
   

¡Hola Mundo!

¡Probemos una solicitud!

1. Selecciona Collections → categories.json → Retrieves a list of categories y haz clic en Send. Deberías ver el resultado:
   
   

Agregar autenticación a las solicitudes

Para usar la API con autenticación de clave API:

1. Agrega las siguientes variables a este entorno o a uno nuevo:

   • api-username
   • api-key
   
   
   (sus valores deben ser válidos para el sitio que estás consultando, por supuesto)

2. Agrega un script a la colección
   Selecciona Collections → Discourse API Documentation → Scripts → Pre-request y pega lo siguiente:

   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")
   })