Centro de soporte de Workiva

Introducción

A partir de la configuración de su colección API, este artículo explica cómo utilizar la API de Workiva para exportar archivos desde Workiva. Esta guía es aplicable a la exportación:

• Documentos como .PDF, .DOCX, o .XHTML
• Hojas de cálculo como .XLSX, .PDF, o .CSV
• Presentaciones en formato .PDF o .PPTX

Existe una opción adicional para exportar archivos nativos de Workiva en formato .tar.gz.

Requisitos previos

Antes de continuar, asegúrese de haber completado todos los pasos de la guía Importing Workiva API Collections into Postman .

Autenticación

1. Abra su espacio de trabajo Postman y asegúrese de que está seleccionado el entorno correcto.

2. Expanda la colección IAM Services, abra la carpeta OAuth2 y seleccione Retrieve a token.

   

3. Haga clic en Enviar para generar un token de autenticación. El token se almacena automáticamente en la variable de entorno {{access_token}} y será utilizado por todas las solicitudes posteriores.

Nota: El token de acceso caduca a los 600 segundos (10 minutos). Una vez caducado, repita este paso para generar un nuevo token.

Iniciar una exportación de archivos (documentos, presentaciones, hojas de cálculo)

Este ejemplo se centra en la exportación de documentos Workiva como .PDF, .DOCX, o .XHTML. Los mismos conceptos se aplican al exportar hojas de cálculo o presentaciones .

1. Expanda la colección Platform API y navegue hasta Documents → Document ID → Export.
2. Abra la página Inicie una solicitud de exportación de documentos .
3. En la pestaña Parámetros, introduzca el documentId .
4. Actualice el cuerpo de la solicitud para especificar el formato de exportación :

   • PDF

     { "pdfOptions": {"includeAlternateRowFill": true, "includeAttachmentLabels": true, "includeComments": true, "includeDraftWatermark": true, "includeHyperlinks": true, "includeLeaderDots": true, "includeTrackChanges": true, "tagForWebAccessibility": true, "useCmykColorspace": true }, "format": "pdf", "sections": [] }

   • DOCX

     { "docxOptions": {"includeLeaderDots": true, "showTableCellShading": true }, "format": "docx", "sections": [] }

   • XHTML

     { "xhtmlOptions": {"editableSimple": true, "editableXhtml": false, "includeExternalHyperlinks": false, "includeHeadersAndFooters": false }, "format": "xhtml", "sections": [] }

5. Envía la solicitud para iniciar la exportación. Este proceso consta de tres pasos:

   • Enviar la solicitud POST. La respuesta incluye una cabecera Location que contiene una URL.

     

   • Realice una solicitud GET a la URL de la cabecera Location para comprobar el estado de la exportación y recuperar la URL del recurso una vez finalizado el procesamiento.

     

   • Realice una última solicitud GET utilizando la URL del recurso para descargar el archivo exportado.

     

El archivo exportado puede devolverse como datos binarios. Este es el comportamiento esperado. Sólo tiene que guardar el archivo con la extensión adecuada (por ejemplo, .pdf, .docx, o .xhtml).

A continuación, revise cómo importar un archivo utilizando la Colección API.