Centro assistenza di Workiva

Introduzione

Partendo dalla configurazione della raccolta API, questo articolo spiega come utilizzare l'API di Workiva per esportare file da Workiva. Questa guida si applica all'esportazione:

• Documenti come .PDF, .DOCX, o .XHTML
• Fogli di calcolo come .XLSX, .PDF, o .CSV
• Presentazioni come .PDF o .PPTX

È disponibile un'opzione aggiuntiva per esportare i file nativi di Workiva nel formato .tar.gz.

Prerequisiti

Prima di procedere, assicurarsi di aver completato tutti i passaggi della guida Importing Workiva API Collections into Postman .

Autenticazione

1. Aprite l'area di lavoro di Postman e assicuratevi che sia selezionato l'ambiente corretto.

2. Espandere la raccolta IAM Services, aprire la cartella OAuth2 e selezionare Retrieve a token.

   

3. Fare clic su Inviare per generare un token di autenticazione. Il token viene automaticamente memorizzato nella variabile d'ambiente {{access_token}} e sarà utilizzato da tutte le richieste successive.

Nota: Il token di accesso scade dopo 600 secondi (10 minuti). Una volta scaduto, ripetere questo passaggio per generare un nuovo token.

Avviare un'esportazione di file (documenti, presentazioni, fogli di calcolo)

Questo esempio si concentra sull'esportazione di documenti Workiva come .PDF, .DOCX, o .XHTML. Gli stessi concetti valgono per l'esportazione di fogli di calcolo o di presentazioni .

1. Espandere la raccolta Platform API e spostarsi su Documents → Document ID → Export.
2. Aprire il sito Avviare una richiesta di esportazione di documenti .
3. Nella scheda Parametri, inserire il documentId.
4. Aggiornare il corpo della richiesta per specificare il formato di esportazione :

   • 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. Inviare la richiesta per avviare l'esportazione. Questo processo si articola in tre fasi:

   • Inviare la richiesta POST. La risposta include un'intestazione Location contenente un URL.

     

   • Effettuare una richiesta GET all'URL nell'intestazione Location per verificare lo stato dell'esportazione e recuperare l'URL della risorsa al termine dell'elaborazione.

     

   • Effettuare una richiesta finale GET utilizzando l'URL della risorsa per scaricare il file esportato.

     

Il file esportato può essere restituito come dato binario. Questo è un comportamento previsto. È sufficiente salvare il file con l'estensione appropriata (ad esempio, .pdf, .docx, o .xhtml).

Successivamente, si analizzerà come importare un file da utilizzando l'API Collection.