Centro de suporte da Workiva

Introdução

Com base na configuração de sua coleção de API, este artigo explica como usar a API da Workiva para exportar arquivos da Workiva. Este guia é aplicável à exportação:

• Documentos como .PDF, .DOCX, ou .XHTML
• Planilhas como .XLSX, .PDF, ou .CSV
• Apresentações como .PDF ou .PPTX

Uma opção adicional está disponível para exportar arquivos nativos do Workiva no formato .tar.gz.

Pré-requisitos

Antes de prosseguir, verifique se você concluiu todas as etapas do guia Importing Workiva API Collections into Postman .

Autenticação

1. Abra o espaço de trabalho do Postman e verifique se o ambiente correto está selecionado.

2. Expanda a coleção IAM Services, abra a pasta OAuth2 e selecione Retrieve a token.

   

3. Clique em Send para gerar um token de autenticação. O token é armazenado automaticamente na variável de ambiente {{access_token}} e será usado por todas as solicitações subsequentes.

Observação: O token de acesso expira após 600 segundos (10 minutos). Depois de expirado, repita essa etapa para gerar um novo token.

Iniciar uma exportação de arquivos (documentos, apresentações, planilhas)

Este exemplo se concentra na exportação de documentos da Workiva como .PDF, .DOCX, ou .XHTML. Os mesmos conceitos se aplicam à exportação de planilhas ou apresentações .

1. Expanda a coleção Platform API e navegue até Documents → Document ID → Export.
2. Abra o site . Inicie uma solicitação de exportação de documentos .
3. Na guia Parameters, insira o documentId.
4. Atualize o corpo da solicitação para especificar o formato de exportação :

   • 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. Envie a solicitação para iniciar a exportação. Esse processo consiste em três etapas:

   • Enviar a solicitação POST. A resposta inclui um cabeçalho Location que contém um URL.

     

   • Faça uma solicitação GET para o URL no cabeçalho Location para verificar o status da exportação e recuperar o URL do recurso assim que o processamento for concluído.

     

   • Faça uma solicitação GET final usando o URL do recurso para fazer o download do arquivo exportado.

     

O arquivo exportado pode ser retornado como dados binários. Esse é o comportamento esperado. Basta salvar o arquivo usando a extensão apropriada (por exemplo, .pdf, .docx, ou .xhtml).

Em seguida, veja como importar um arquivo usando a API Collection.