Centro de soporte de Workiva

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 OpenAPI oas.yaml.

3. Abrir Bruno. En la esquina superior izquierda, haga clic en el icono + y seleccione Importar colección.

   

4. Haga clic en el enlace "elegir archivo(s)" 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, ../Documents/Bruno).

   Opcionalmente, cambie la disposición de las carpetas de "Etiquetas" a "Rutas" y haga clic en Importar.

   

Paso 2: Configurar el entorno global

1. En la sección Espacio de trabajo de Bruno, haga clic en la pestaña Entornos globales y, a continuación, haga clic en Crear entorno.

   

2. Escriba un nombre para su Entorno Global y haga clic en Crear.

    

3. Cree las siguientes variables globales:
   • access_token
   • ClientID
   • ClientSecret
   • versión_api

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

   

5. Guarda las variables.

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 en el área Workspace de Bruno.

   

2. Haga clic en el menú desplegable Workiva en la esquina superior derecha de la pantalla Bruno y seleccione el Entorno/región apropiado de la lista Colección.

   

3. Haga clic en la pestaña "Auth", seleccione "Token de portador" en el menú desplegable y configure el campo "Token" para que utilice la variable {{access_token}}.

   

4. Seleccione la pestaña Script.

5. 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. La documentación puede consultarse aquí: https://developers.workiva.com/2026-01-01/versioning.html

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

   

   Cuando haya terminado, haga clic en el botón "Guardar" situado en la parte inferior izquierda del área de trabajo.

6. En la colección API Workiva, navegue hasta la carpeta oauth2 > token y haga clic en Recuperar un token para abrirla.

   

7. Haga clic en el icono ">>" situado bajo la Url y en la pestaña "Script".

   

   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); 

8. Guarda los cambios.

Paso 3a (Opcional): Importar APIs adicionales de Workiva

Siga la misma secuencia de pasos anterior para importar APIs de Workiva adicionales:

wData OpenAPI oas.yaml el archivo puede descargarse de aquí

Cadenas OpenAPI oas.yaml el archivo se puede descargar desde aquí

Paso 4: Generar un token de portador

1. Para el cuerpo de la solicitud OAuth2, establezca las siguientes variables (si aún no se han establecido):
   • {{ClientID}}
   • {{ClientSecret}}

     • Para configurar (o comprobar) las variables, haga clic en Workiva en la parte superior derecha del espacio de trabajo de Bruno, haga clic en la pestaña Global y elija "Configurar".

       

       Edite las variables, según sea necesario.

       

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 .

Solución de problemas

• Asegúrese de que está haciendo referencia al entorno correcto. Si la colección tiene por defecto su entorno No, cámbielo a su entorno especificado.
• 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.