Centrum wsparcia Workiva

W tym przewodniku dowiesz się, jak importować kolekcje API Workiva do Postman przy użyciu specyfikacji OpenAPI, konfigurować zmienne środowiskowe i weryfikować żądania od początku do końca.

Wymagania wstępne

Zanim zaczniesz, upewnij się, że masz następujące rzeczy:

• Postman zainstalowany (zalecana wersja 10+)
• Prawidłowy identyfikator klienta Workiva i tajny klucz klienta
• Dostęp do plików Workiva OpenAPI .yaml za pośrednictwem portalu programistów Workiva
• Zrozumienie środowiska Workiva, w którym pracujesz: app, eulub apac

Tło

Interfejsy API Workiva są publikowane w formacie OpenAPI (.yaml). Specyfikacje te można importować bezpośrednio do narzędzia Postman, co pozwala na szybsze opracowywanie, testowanie i integrowanie przepływów pracy 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 Postman, wybierz Importuji prześlij pobrany plik. 
   
4. Sprawdź, czy w programie Postman pojawiła się nowa kolekcja zatytułowana Workiva API. 
   

Krok 2: Skonfiguruj swoje środowisko

W programie Postman otwórz kartę Środowiska i utwórz nowe środowisko. W celach testowych niniejszy przewodnik wykorzystuje środowisko o nazwie<WorkspaceName> _Workiva_API.

Zalecenie: Użyj spójnej konwencji nazewnictwa, takiej jak NazwaOrganizacji_NazwaObszaruRoboczego, aby wyraźnie odróżnić zmienne w różnych obszarach roboczych Workiva.

Dodaj następujące zmienne, używając kolumny Wartość bieżąca, a następnie kliknij Zapisz.

📘 Jak używać zmiennych środowiskowych w programie Postman

Krok 3: Skonfiguruj OAuth2 – Pobierz token

1. Wybierz kolekcję Workiva API.
2. Ustaw autoryzację, aby użyć zmiennej {{access_token}}.
3. Wybierz kartę Skrypty.

4. 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 pm.request.headers.upsert({ key: "X-Version", value: pm.environment.get("api_version") });

   

    

5. Wybierz kartę Zmienne.
6. Zaktualizuj zmienną baseUrl, aby używać {{environment}} zamiast zakodowanej na stałe domeny.

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

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

Krok 4: Zapisz token dostępu

1. W sekcji Pobierz token, wybierz kartę Skrypty i dodaj poniższy kod do sekcji Po żądaniu.

   pm.test("Kod statusu wynosi 200", funkcja () { pm.odpowiedź.do.mieć.status(200); }); pm.test("Zapisz token dostępu do zmiennej środowiskowej", funkcja () { var jsonData = pm.odpowiedź.json(); pm.środowisko.ustaw("token_dostępu", jsonData.token_dostępu); });

   

2. Wyślij prośbę. Powinieneś otrzymać odpowiedź 200 OK, a Twój access_token zostanie automatycznie zapisany.

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 :
   • Ustaw typ autoryzacji na Token nośnika.

   • Użyj {{access_token}} jako wartości tokena.

     

   • Na karcie Zmienne zaktualizuj zmienną baseUrl, aby używać {{environment}} zamiast zakodowanej na stałe domeny. Ułatwia to przełączanie się między środowiskami takimi jak app, eulub apac.
   • Upewnij się, że każde żądanie jest ustawione na Dziedzicz uwierzytelniania od rodzica.
   • 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.