Centrum wsparcia Workiva

Wprowadzenie

W tym artykule, bazując na konfiguracji kolekcji interfejsów API, wyjaśniono, jak używać interfejsu API Workiva do eksportowania plików z Workiva. Niniejszy przewodnik ma zastosowanie podczas eksportowania:

• Dokumenty w formacie .PDF, .DOCXlub .XHTML
• Arkusze kalkulacyjne w formacie .XLSX, .PDFlub .CSV
• Prezentacje w formacie .PDF lub .PPTX

Dodatkowa opcja jest dostępna do eksportowania natywnych plików Workiva w formacie .tar.gz.

Wymagania wstępne

Przed kontynuowaniem upewnij się, że wykonałeś wszystkie kroki opisane w przewodniku Importowanie kolekcji API Workiva do programu Postman .

Uwierzytelnianie

1. Otwórz obszar roboczy programu Postman i upewnij się, że wybrano prawidłowe środowisko.

2. Rozwiń kolekcję Usługi IAM, otwórz folder OAuth2 i wybierz Pobierz token.

   

3. Kliknij Wyślij, aby wygenerować token uwierzytelniający. Token jest automatycznie zapisywany w zmiennej środowiskowej {{access_token}} i będzie używany przez wszystkie kolejne żądania.

Uwaga: Token dostępu wygasa po 600 sekundach (10 minutach). Po upływie terminu ważności powtórz ten krok, aby wygenerować nowy token.

Rozpocznij eksport pliku (dokumenty, prezentacje, arkusze kalkulacyjne)

W tym przykładzie skupiono się na eksporcie dokumentów Workiva w formacie .PDF, .DOCXlub .XHTML. Te same koncepcje obowiązują podczas eksportowania arkuszy kalkulacyjnych lub prezentacji.

1. Rozwiń kolekcję Platform API i przejdź do Dokumenty → Identyfikator dokumentu → Eksportuj.
2. Otwórz żądanie Rozpocznij eksport dokumentu .
3. Na karcie Parametry wprowadź documentId.
4. Zaktualizuj treść żądania, aby określić format eksportu :

   • PDF

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

   • DOCX

     { "docxOptions": { "includeLeaderDots": prawda, "showTableCellShading": prawda }, "format": "docx", "sekcje": [] }

   • XHTML

     { "xhtmlOptions": { "editableSimple": prawda, "editableXhtml": fałsz, "includeExternalHyperlinks": fałsz, "includeHeadersAndFooters": fałsz }, "format": "xhtml", "sections": [] }

5. Wyślij żądanie zainicjowania eksportu. Proces ten składa się z trzech etapów:

   • Wyślij żądanie POST. Odpowiedź zawiera nagłówek Lokalizacja zawierający adres URL.

     

   • Wykonaj żądanie GET do adresu URL w nagłówku Location, aby sprawdzić stan eksportu i pobrać adres URL zasobu po zakończeniu przetwarzania.

     

   • Wykonaj ostatnie żądanie GET, używając adresu URL zasobu , aby pobrać wyeksportowany plik.

     

Wyeksportowany plik może zostać zwrócony jako dane binarne. Jest to oczekiwane zachowanie. Wystarczy zapisać plik z odpowiednim rozszerzeniem (na przykład .pdf, .docxlub .xhtml).

Następnie zapoznaj się ze sposobem importowania pliku za pomocą kolekcji API.