Centrum wsparcia Workiva

Tło

Interfejsy API Workiva są publikowane w formacie OpenAPI (.yaml). Te specyfikacje można importować bezpośrednio do klientów API, takich jak Bruno, co pozwala na pracę z w pełni ustrukturyzowanymi kolekcjami bez konieczności ręcznego tworzenia żądań.

Krok 1: Importowanie kolekcji API Workiva

1. Przejdź do stronyGenerowanie kodu platformy Workiva.
2. Pobierz plik OpenAPIoas.yaml.

3. OtwórzBruno. W lewym górnym rogu kliknij ikonę + i wybierzImportuj kolekcję.

   

4. Kliknij łącze „wybierz plik(i)” i wybierz pobrany plik.yaml.

   

5. Gdy pojawi się monit, utwórz lub wybierz folder lokalny, w którym Bruno będzie przechowywał kolekcję (na przykład../Dokumenty/Bruno).

   Opcjonalnie zmień układ folderów z „Tagi” na „Ścieżki” i kliknij Importuj.

   

Krok 2: Skonfiguruj środowisko globalne

1. W sekcji Obszar roboczy Bruno kliknij kartęŚrodowiska globalne , a następnie kliknij opcjęUtwórz środowisko.

   

2. Wpisz nazwę swojego środowiska globalnego, a następnie kliknijUtwórz.

    

3. Utwórz następujące zmienne globalne:
   • token_dostępu
   • Identyfikator klienta
   • ClientSecret
   • wersja_api

4. Wypełnij wartości dlaClientIDiClientSecret. Pozostawaccess_tokenpuste i ustawapi_versionna2026-01-01.

   

5. Zapisz zmienne.

Krok 3: Skonfiguruj OAuth 2.0 – Pobierz token

Aby ponownie wykorzystać uwierzytelnianie w wielu zbiorach, token dostępu OAuth zostanie zapisany jako globalna zmienna środowiskowa [.

1. Wybierz kolekcjęWorkiva APIz obszaru roboczego Bruno.

   

2. Kliknij menu rozwijane Workiva w prawym górnym rogu ekranu Bruno i wybierz odpowiednie środowisko/region z listy kolekcji.

   

3. Kliknij kartę „Autoryzacja”, wybierz „Token okaziciela” z listy rozwijanej i ustaw pole „Token” tak, aby używało zmiennej{{access_token}}.

   

4. Wybierz kartęSkrypt.

5. Dodaj następujący skrypt do sekcjiPre-request.

   W przypadku interfejsów API platformy2026nagłówekX-Versionjest wymagany przy każdym żądaniu. Ten skrypt zapewnia spójne stosowanie nagłówka w całej kolekcji, zgodnie z wymaganiami dotyczącymi wersji interfejsu API firmy Workiva w 2026 r. Dokumentację można znaleźć tutaj: https://developers.workiva.com/2026-01-01/versioning.html

   Uwaga:Ten wymóg dotyczy obecnie tylko interfejsów API platformy.

   // Dodaj lub zaktualizuj nagłówek X-Version (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")); 

   

   Po zakończeniu kliknij przycisk „Zapisz” znajdujący się w lewym dolnym rogu obszaru roboczego.

6. W kolekcji API Workiva przejdź do folderuoauth2 > tokeni kliknijPobierz token , aby go otworzyć.

   

7. Kliknij ikonę ">>" pod adresem URL i kliknij zakładkę "Skrypt".

   

   W sekcji skryptuPost Responsedodaj następujący kod, aby zapisać token globalnie:

   const body = res.getBody(); bru.setGlobalEnvar("access_token", body.access_token); 

8. Zapisz zmiany.

Krok 3a (opcjonalny): Importuj dodatkowe interfejsy API Workiva

Aby zaimportować dodatkowe interfejsy API Workiva, wykonaj tę samą sekwencję kroków, co powyżej:

PlikwData OpenAPIoas.yamlmożna pobrać stąd

Łańcuchy OpenAPIPlik oas.yamlmożna pobrać stąd

Krok 4: Wygeneruj token nośnika

1. W treści żądania OAuth2 ustaw następujące zmienne (jeśli nie zostały jeszcze ustawione):
   • {{ID klienta}}
   • {{Sekret klienta}}

     • Aby ustawić (lub sprawdzić) zmienne, kliknij Workiva w prawym górnym rogu obszaru roboczego Bruno, kliknij kartę Globalne i wybierz „Konfiguruj”.

       

       W razie potrzeby edytuj zmienne.

       

2. Wyślij żądaniePobierz token.
3. W przypadku powodzenia odpowiedź będzie zawierać token nośnika i zostanie automatycznie zapisana jako zmienna globalna.

Rozwiązywanie problemów

• Upewnij się, że odwołujesz się do prawidłowegoŚrodowiska. Jeśli kolekcja domyślnie ma środowisko Brak, zmień je naokreślone przez Ciebie środowisko.
• Jeśli żądanie zwróci błąd 401 lub pustą odpowiedź, sprawdź ponownie, czy wartości identyfikatora klienta, tajnego klucza klienta, wersji API i środowiska są poprawne.