Centro de soporte de Workiva

Esta guía le guiará a través de la importación de colecciones Workiva API en Postman utilizando las especificaciones OpenAPI, la configuración de variables de entorno, y la validación de las solicitudes de extremo a extremo.

Requisitos previos

Antes de empezar, asegúrate de tener lo siguiente:

• Postman instalado (se recomienda la versión 10+)
• Un ID de cliente Workiva válido y Secreto de cliente
• Acceso a los archivos .yaml de Workiva OpenAPI a través del portal para desarrolladores de Workiva
• Conocimiento del entorno Workiva en el que trabaja: app, eu, o apac

Fondo

Las APIs de Workiva se publican en formato OpenAPI (.yaml). Estas especificaciones pueden importarse directamente a Postman, lo que permite agilizar los flujos de trabajo de desarrollo, pruebas e integración sin necesidad de construir manualmente las solicitudes.

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. Abra Postman, seleccione Importar, y cargue el archivo descargado. 
   
4. Confirme que una nueva colección titulada Workiva API aparece en Postman. 
   

Paso 2: Establecer tu Entorno

En Postman, abra la pestaña Entornos y cree un nuevo entorno. Para fines de prueba, esta guía utiliza un entorno llamado <WorkspaceName>_Workiva_API.

Recomendación: Utilice una convención de nomenclatura coherente como OrganizationName_WorkspaceName para distinguir claramente las variables en los distintos espacios de trabajo de Workiva.

Añada las siguientes variables utilizando la columna Valor actual y, a continuación, haga clic en Guardar.

📘 Cómo utilizar variables de entorno en Postman

Paso 3: Configurar OAuth2 - Recuperar un token

1. Seleccione la colección Workiva API.
2. Configure la autorización para utilizar la variable {{access_token}}.
3. Seleccione la pestaña Scripts.

4. 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 pm.request.headers.upsert({ key: "X-Version", value: pm.environment.get("api_version") });

   

    

5. Selecciona la pestaña Variables.
6. Actualiza la variable baseUrl para utilizar {{environment}} en lugar de un dominio codificado.

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

Se ha actualizado a:
https://api.{{environment}}.wdesk.com/iam/v1

Paso 4: Guardar el código de acceso

1. Desde Recuperar un token, selecciona la pestaña Scripts y añade el código siguiente a la sección Post-request.

   pm.prueba("El código de estado es 200", función () { pm.respuesta.a.tiene.estado(200); }); pm.prueba("Guardar token de acceso en variable de entorno", función () { var jsonData = pm.respuesta.json(); pm.entorno.establecer("token_acceso", jsonData.token_acceso); });

   

2. Envía la solicitud. Deberías recibir una respuesta 200 OK y tu access_token se guardará automáticamente.

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 :
   • Establece el Tipo de Autorización en Token de portador.

   • Utiliza {{access_token}} como valor del token.

     

   • En la pestaña Variables, actualiza la variable baseUrl para utilizar {{environment}} en lugar de un dominio codificado. Esto facilita el cambio entre entornos como app, eu, o apac.
   • Asegúrate de que cada solicitud está establecida en Heredar auth del padre.
   • 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.