W Workiva generowanie tokena dostępu (w szczególności tokena na okaziciela OAuth2) jest procesem dwuetapowym: najpierw tworzysz API Grant, aby uzyskać poświadczenia, a następnie używasz tych poświadczeń, aby zażądać rzeczywistego tokena.
1. Utwórz grant API
Ważne: Aby wykonać ten krok, musisz być właścicielem obszaru roboczego.
Aby uzyskać Client ID & Secret:
- Kliknij ikonę swojego identyfikatora w prawym górnym rogu strony Workiva, a następnie wybierz Ustawienia przestrzeni roboczej.
- Wybierz zakładkę Security, a następnie kliknij Create API Grant.
- Na stronie Update Grant wypełnij następujące pola:
- Wprowadź nazwę klienta i nazwę użytkownika Workiva, w imieniu którego będzie działać dotacja.
- Wybierz "Poświadczenia klienta OAuth2" jako typ klienta .
- Wybierz wymagane Scopes (uprawnienia) dla punktów końcowych API, których planujesz używać.
- Ustaw datę Expires.
- O ile nie jest to wyraźnie wymagane przez twoją organizację, możesz zignorować pole Ip Allowlist.
- Kliknij Dodaj dotację.
Ważne: Natychmiast skopiuj identyfikator klienta i sekret klienta, ponieważ sekret nie zostanie ponownie wyświetlony.
2. Pobierz token na okaziciela
Po uzyskaniu poświadczeń musisz wymienić je na krótkotrwały token dostępu, wysyłając żądanie POST do usługi Workiva IAM.
- Punkt końcowy:
https://api.app.wdesk.com(jest to wartość domyślna dla USA; inne regiony mają inne punkty końcowe). - Nagłówki: Ustaw
Content-Typenaapplication/x-www-form-urlencoded. - Parametry nadwozia:
-
grant_type:client_credentials -
client_id: [Twój identyfikator klienta] -
client_secret: [Twój sekret klienta]
-
- Wygaśnięcie: Tokeny na okaziciela Workiva są zazwyczaj ważne przez 10 minut. Musisz okresowo odświeżać je dla długotrwałych procesów.
Tokeny SEC EDGAR Next
Jeśli generujesz tokeny specjalnie do składania dokumentów SEC (EDGAR Next), różnią się one od standardowych tokenów API:
- Tokeny te (Filer API Token i User Token) są tworzone na pulpicie nawigacyjnym SEC EDGAR Filer Management.
- Po ich uzyskaniu możesz zarządzać nimi w Workiva w sekcji SEC Reporting > Manage EDGAR Next Tokens.