Workiva-ondersteuningscentrum

Invoering

Voortbouwend op de configuratie van uw API-verzameling, legt dit artikel uit hoe u de Workiva API kunt gebruiken om bestanden vanuit Workiva te exporteren. Deze handleiding is van toepassing bij het exporteren:

• Documenten als .PDF, .DOCX, of .XHTML
• Spreadsheets als .XLSX, .PDF, of .CSV
• Presentaties als .PDF of .PPTX

Er is een extra optie beschikbaar voor het exporteren van native Workiva-bestanden in het formaat .tar.gz.

Voorwaarden

Voordat u verdergaat, moet u ervoor zorgen dat u alle stappen in de handleiding Workiva API-collecties importeren in Postman hebt voltooid.

Authenticatie

1. Open je Postman-werkruimte en zorg ervoor dat de juiste omgeving is geselecteerd.

2. Vouw de verzameling IAM-services uit, open de map OAuth2 en selecteer Een token ophalen.

   

3. Klik op Verzenden om een ​​authenticatietoken te genereren. Het token wordt automatisch opgeslagen in de omgevingsvariabele {{access_token}} en zal door alle volgende verzoeken worden gebruikt.

Opmerking: Het toegangstoken verloopt na 600 seconden (10 minuten). Als het token is verlopen, herhaal je deze stap om een ​​nieuw token te genereren.

Een bestandsexport starten (documenten, presentaties, spreadsheets)

Dit voorbeeld richt zich op het exporteren van Workiva-documenten als .PDF, .DOCX, of .XHTML. Dezelfde concepten gelden bij het exporteren van spreadsheets of presentaties.

1. Vouw de Platform API collectie uit en navigeer naar Documenten → Document-ID → Exporteren.
2. Open de Start een documentexportverzoek
3. Voer in het tabblad Parametersde documentIdin.
4. Werk de aanvraagbody bij om het exportformaat te specificeren:

   • 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. Verstuur het verzoek om de export te starten. Dit proces bestaat uit drie stappen:

   • Verzend het POST-verzoek. Het antwoord bevat een Location header met een URL.

     

   • Verstuur een GET-verzoek naar de URL in de Location -header om de exportstatus te controleren en de resource URL op te halen zodra de verwerking is voltooid.

     

   • Voer een laatste GET-verzoek uit met behulp van de resource-URL om het geëxporteerde bestand te downloaden.

     

Het geëxporteerde bestand kan als binaire data worden geretourneerd. Dit is het verwachte gedrag. Sla het bestand eenvoudigweg op met de juiste extensie (bijvoorbeeld .pdf, .docxof .xhtml).

Bekijk vervolgens hoe je een bestand kunt importeren met behulp van deAPI -collectie.