In Workiva erfolgt die Erstellung eines Zugriffstokens (insbesondere eines OAuth2-Tokens) in zwei Schritten: Sie erstellen zunächst eine API-Grant, um Anmeldedaten zu erhalten, und verwenden diese dann, um das eigentliche Token anzufordern.
1. Erstellen Sie eine API-Berechtigung
Wichtig: Sie müssen Eigentümer des Arbeitsbereichs sein, um diesen Schritt auszuführen.
Um eine Client ID & Secret zu erhalten:
- Klicken Sie auf Ihr ID-Symbol in der oberen rechten Ecke der Workiva-Seite und wählen Sie dann Arbeitsbereichseinstellungen.
- Wählen Sie die Registerkarte Sicherheit und klicken Sie dann auf API-Grant erstellen.
- Auf der Seite Grant aktualisieren füllen Sie die folgenden Felder aus:
- Geben Sie einen Client-Namen und den Workiva-Benutzernamen ein, in dessen Namen der Grant agieren soll.
- Wählen Sie "OAuth2 Client Credentials" als Client-Typ.
- Wählen Sie die erforderlichen Geltungsbereiche (Berechtigungen) für die API-Endpunkte, die Sie verwenden möchten.
- Legen Sie das Expires Datum fest.
- Das Feld Ip Allowlist können Sie ignorieren, es sei denn, Ihr Unternehmen verlangt dies ausdrücklich.
- Klicken Sie auf Zuweisung hinzufügen.
Wichtig: Kopieren Sie die Client ID und das Client Secret sofort, da das Geheimnis nicht mehr angezeigt wird.
2. Abrufen des Bearer Token
Sobald Sie Ihre Anmeldedaten haben, müssen Sie diese gegen ein kurzlebiges Zugriffstoken austauschen, indem Sie eine POST Anfrage an den Workiva IAM Service stellen.
- Endpunkt:
https://api.app.wdesk.com(dies ist die Standardeinstellung für die USA; andere Regionen haben andere Endpunkte). - Kopfzeilen: Setzen Sie
Content-Typeaufapplication/x-www-form-urlencoded. - Body-Parameter:
-
grant_type:client_credentials -
client_id: [Ihre Client-ID] -
client_secret: [Ihr Kundengeheimnis]
-
- Verfall: Workiva-Inhaber-Token sind in der Regel 10 Minuten lang gültig. Bei lang laufenden Prozessen müssen Sie diese regelmäßig aktualisieren.
SEC EDGAR Next-Tokens
Wenn Sie Token speziell für die Einreichung bei der SEC (EDGAR Next) erzeugen, unterscheiden sich diese von den Standard-API-Tokens:
- Diese Token (Filer API Token und User Token) werden auf dem Dashboard EDGAR Filer Management der SEC erstellt.
- Sobald Sie diese erhalten haben, können Sie sie in Workiva unter SEC Reporting > Manage EDGAR Next Tokens verwalten.