Centro de soporte de Workiva

Esta guía le guiará a través de la importación de colecciones Workiva API en Bruno utilizando las especificaciones OpenAPI. Aprenderá a configurar variables de entorno globales, a autenticarse mediante OAuth 2.0 y a validar solicitudes de API de extremo a extremo.

Requisitos previos

1. Descargue e instale Bruno desde www.usebruno.com .

Fondo

Las APIs de Workiva se publican en formato OpenAPI (.yaml). Estas especificaciones pueden importarse directamente en clientes de API como Bruno, lo que permite trabajar con colecciones totalmente estructuradas sin necesidad de crear solicitudes manualmente.

Paso 1: Importar la colección API de Workiva

1. Vaya a la página Workiva Platform Code Generation .
2. Descargue el archivo .yaml de OpenAPI .

3. Abrir Bruno. En la esquina superior izquierda, haga clic en el menú de tres puntos y seleccione Importar colección.

   

4. Seleccione archivo OpenAPI V3 y elija el archivo .yaml descargado.

   

5. Cuando se le solicite, cree o seleccione una carpeta local donde Bruno almacenará la colección (por ejemplo, Bruno Collections).

   

Paso 2: Configurar el entorno global

1. En la esquina superior derecha de Bruno, haga clic en el icono del globo y seleccione Configurar.

   

2. Seleccione Crear entorno global.
3. Cree las siguientes variables globales:
   • access_token
   • Entorno
   • ClientID
   • ClientSecret
   • versión_api

4. Rellene los valores de Entorno, ClientID, y ClientSecret. Deje en blanco access_token y establezca api_version en 2026-01-01.

   

5. Salvar el medio ambiente.

Paso 3: Configurar OAuth 2.0 - Recuperar un token

Para reutilizar la autenticación en varias colecciones, el token de acceso OAuth se almacenará como una variable de entorno global .

1. Seleccione la colección Workiva API.
2. Selecciona la pestaña Variables.

3. Actualiza la variable baseUrl para utilizar {{environment}} en lugar de un dominio codificado.

   Original:
   https://api.app.wdesk.com

   Actualizado:
   https://api.{{environment}}.wdesk.com

4. Establezca la autorización en Token de portador y utilice la variable {{access_token}}.
5. Seleccione la pestaña Scripts.

6. Añada el siguiente script a la sección Pre-request.

   Para las API de la plataforma 2026, se requiere el encabezado X-Version en cada solicitud. Este script garantiza que la cabecera se aplique de forma coherente en toda la colección, de acuerdo con los requisitos de versionado de la API 2026 de Workiva.

   Nota: Este requisito sólo se aplica actualmente a las API de plataforma.

   // Añade o actualiza la cabecera X-Version (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")); 

   

7. En la colección API de Workiva, navegue hasta la carpeta oauth2 y abra Recuperar un token.

8. En la sección de script Post Response, añada lo siguiente para guardar el token globalmente:

   const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token); 

9. Guarda los cambios.

Paso 4: Generar un token de portador

1. En el cuerpo de la solicitud OAuth2, establezca:
   • {{ClientID}}
   • {{ClientSecret}}
2. Envíe la solicitud Retrieve a token.

3. Si tiene éxito, la respuesta incluirá un token de portador y se guardará automáticamente como variable global .

   

Ahora puede enviar solicitudes autenticadas. Si tiene éxito, verá su lista de documentos devuelta en la respuesta.

Paso 5: Importar y configurar la colección de APIs Wdata y Chains

1. Vaya a la página Wdata Code Generation.
2. Descargue el archivo .yaml e impórtelo en Postman (Siga los pasos descritos en Paso 1: Importar la colección de APIs de Workiva). Nota: El nombre de archivo .yaml será probablemente el mismo que el de la colección de APIs de Workiva .
3. En la colección Wdata :
   • Selecciona la pestaña Variables.

   • Actualiza la variable baseUrl para utilizar {{environment}} en lugar de un dominio codificado.

     Original:
     https://h.app.wdesk.com/s/wdata/oc/api

     Actualizado:
     https://h.{{environment}}.wdesk.com/s/wdata/prep

   • Establezca la autorización en Token de portador y utilice la variable {{access_token}}.
   • Repita los mismos pasos anteriores para la colección de APIs Chains, asegurándose de que los ajustes de autorización y la variable baseUrl están configurados de la misma manera.

Solución de problemas

• Asegúrate de que haces referencia al entorno correcto. Si la colección Predetermina como No su entorno, cámbiala a tu Entorno especificado.
• Confirma que la variable baseUrl es coherente con la configuración de tu entorno y de la colección.
• Asegúrate de establecer la variable de colección baseUrl para utilizar {{environment}}; de lo contrario, tus solicitudes pueden fallar.
• Si su solicitud devuelve una respuesta 401 o en blanco, vuelva a comprobar que los valores de ID de cliente, Secreto de cliente, Versión_API y Entorno son correctos.