Centrum wsparcia Workiva

W tym przewodniku dowiesz się, jak importować kolekcje API Workiva do Bruno przy użyciu specyfikacji OpenAPI. Dowiesz się, jak skonfigurować globalne zmienne środowiskowe, uwierzytelniać się za pomocą protokołu OAuth 2.0 i weryfikować żądania API od początku do końca.

Wymagania wstępne

1. Pobierz i zainstaluj Bruno z www.usebruno.com .

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 strony Generowanie kodu platformy Workiva .
2. Pobierz plik OpenAPI .yaml.

3. Otwórz Bruno. W lewym górnym rogu kliknij menu z trzema kropkami i wybierz Importuj kolekcję.

   

4. Wybierz Plik OpenAPI V3 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 Kolekcje Bruno).

   

Krok 2: Skonfiguruj środowisko globalne

1. W prawym górnym rogu Bruno kliknij ikonę globusa i wybierz opcję Konfiguruj.

   

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

4. Wypełnij wartości dla Environment, ClientIDi ClientSecret. Pozostaw access_token puste i ustaw api_version na 2026-01-01.

   

5. Chroń środowisko.

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 API.
2. Wybierz kartę Zmienne.

3. Zaktualizuj zmienną baseUrl, aby używać {{environment}} zamiast zakodowanej na stałe domeny.

   Oryginał:
   https://api.app.wdesk.com

   Zaktualizowano:
   https://api.{{environment}}.wdesk.com

4. Ustaw autoryzację na Bearer Token i użyj zmiennej {{access_token}}.
5. Wybierz kartę Skrypty.

6. Dodaj następujący skrypt do sekcji Pre-request.

   W przypadku interfejsów API platformy 2026nagłówek X-Version jest 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.

   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")); 

   

7. W kolekcji API Workiva przejdź do folderu oauth2 i otwórz Pobierz token.

8. W sekcji skryptu Post Response dodaj następujący kod, aby zapisać token globalnie:

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

9. Zapisz zmiany.

Krok 4: Wygeneruj token nośnika

1. W treści żądania OAuth2 ustaw:
   • {{ID klienta}}
   • {{Sekret klienta}}
2. Wyślij żądanie Pobierz token.

3. W przypadku powodzenia odpowiedź będzie zawierać token nośnika i zostanie automatycznie zapisana jako zmienna globalna .

   

Możesz teraz wysyłać uwierzytelnione żądania. Jeśli operacja się powiedzie, w odpowiedzi zobaczysz listę dokumentów.

Krok 5: Importowanie i konfiguracja kolekcji API Wdata i Chains

1. Przejdź do strony Generowanie kodu Wdata.
2. Pobierz plik .yaml i zaimportuj go do programu Postman (Wykonaj kroki opisane w Krok 1: Importuj kolekcję API Workiva). Uwaga: Nazwa pliku .yaml będzie prawdopodobnie taka sama jak nazwa pliku Workiva API Collection.
3. W kolekcji Wdata :
   • Wybierz kartę Zmienne.

   • Zaktualizuj zmienną baseUrl, aby używać {{environment}} zamiast zakodowanej na stałe domeny.

     Oryginał:
     https://h.app.wdesk.com/s/wdata/oc/api

     Zaktualizowano:
     https://h.{{environment}}.wdesk.com/s/wdata/prep

   • Ustaw autoryzację na Bearer Token i użyj zmiennej {{access_token}}.
   • Powtórz te same kroki powyżej dla kolekcji Chains API Collection, upewniając się, że ustawienia autoryzacji i zmienna baseUrl są skonfigurowane w ten sam sposób.

Rozwiązywanie problemów

• Upewnij się, że odwołujesz się do prawidłowego Środowiska. Jeśli kolekcja domyślnie ma środowisko Brak, zmień je na określone przez Ciebie środowisko.
• Sprawdź, czy zmienna baseUrl jest spójna w całym środowisku i ustawieniach kolekcji.
• Upewnij się, że zmienna kolekcji baseUrl jest ustawiona tak, aby używała {{environment}}; w przeciwnym razie Twoje żądania mogą się nie powieść.
• 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.