Portail de support Workiva

Introduction

En se basant sur la configuration de votre collection API, cet article explique comment utiliser l'API Workiva pour exporter des fichiers depuis Workiva. Ce guide s'applique à l'exportation :

• Documents au format .PDF, .DOCX, ou .XHTML
• Feuilles de calcul sous .XLSX, .PDF, ou .CSV
• Présentations sous .PDF ou .PPTX

Une option supplémentaire est disponible pour exporter les fichiers Workiva natifs au format .tar.gz.

Conditions préalables

Avant de poursuivre, assurez-vous d'avoir effectué toutes les étapes du guide Importing Workiva API Collections into Postman .

Authentification

1. Ouvrez votre espace de travail Postman et assurez-vous que l'environnement correct est sélectionné.

2. Développez la collection IAM Services, ouvrez le dossier OAuth2 et sélectionnez Retrieve a token.

   

3. Cliquez sur Send pour générer un jeton d'authentification. Le jeton est automatiquement stocké dans la variable d'environnement {{access_token}} et sera utilisé pour toutes les demandes ultérieures.

Note : Le jeton d'accès expire après 600 secondes (10 minutes). Une fois qu'il a expiré, répétez cette étape pour générer un nouveau jeton.

Lancer une exportation de fichiers (documents, présentations, feuilles de calcul)

Cet exemple se concentre sur l'exportation de documents Workiva en tant que .PDF, .DOCX, ou .XHTML. Les mêmes concepts s'appliquent à l'exportation des feuilles de calcul ou des présentations .

1. Développez la collection Platform API et naviguez jusqu'à Documents → Document ID → Export.
2. Ouvrir la demande Initier une demande d'exportation de documents .
3. Dans l'onglet Parameters, entrez le documentId.
4. Mettre à jour le corps de la demande pour spécifier le format d'exportation :

   • 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. Envoyer la demande pour lancer l'exportation. Ce processus se déroule en trois étapes :

   • Envoyer la requête POST. La réponse comprend un en-tête Location contenant une URL.

     

   • Faites une demande GET à l'URL dans l'en-tête Location pour vérifier le statut de l'exportation et récupérer l'URL de la ressource une fois le traitement terminé.

     

   • Effectuez une dernière requête GET en utilisant l'URL de la ressource pour télécharger le fichier exporté.

     

Le fichier exporté peut être renvoyé sous forme de données binaires. C'est un comportement attendu. Il suffit d'enregistrer le fichier en utilisant l'extension appropriée (par exemple, .pdf, .docx, ou .xhtml).

Ensuite, nous verrons comment importer un fichier à l'aide de l'API Collection.