Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Verwenden Sie die Vantage-Benutzeroberfläche, um Public API-Clients zu erstellen, zu konfigurieren und zu löschen, die von integrierten Anwendungen zur Authentifizierung bei der Vantage-API verwendet werden. Eine programmgesteuerte Alternative finden Sie unter Erstellen eines Clients mit der Vantage-API.
Nur ein Mandantenadministrator kann Public API-Clients erstellen oder verwalten.

​
Erstellen eines öffentlichen API-Clients

1

Konfiguration öffnen

Klicken Sie in Vantage im linken Bereich auf Configuration.
2

Client-Erstellung starten

Gehen Sie im Dialogfeld Tenant Administration wie folgt vor:
  • Erster Client in diesem Mandanten: Klicken Sie auf Create API Client.
  • Jeder weitere Client: Klicken Sie auf Public API-Client. Öffnen Sie dann auf der Seite Public API-Client die Dropdown-Liste New Client und klicken Sie auf Add Client.
Dropdown-Liste „New Client“ mit der Option „Add Client“
3

Client ID und Client Secret kopieren

Kopieren Sie im Dialogfeld Client Created jeden Wert, indem Sie auf das Symbol copy klicken. Alternativ können Sie auf Save to File klicken, um eine TXT-Datei mit beiden Werten herunterzuladen.
Dialogfeld „Client Created“ mit Client ID und Client Secret
Das Client Secret wird nur einmal bei der Erstellung angezeigt. Speichern Sie es sofort – Sie können den vollständigen Wert später nicht mehr anzeigen.
4

Dialogfeld schließen

Klicken Sie auf Close. Die Seite Public API-Client wird geöffnet. Dort können Sie den neuen Client konfigurieren.

​
Konfigurieren eines Public API-Clients

Nachdem Sie einen Public API-Client erstellt haben, konfigurieren Sie dessen Einstellungen. Um die Einstellungen eines Clients zu öffnen, klicken Sie auf der Seite Public API Client auf den Namen des Clients oder suchen Sie nach dem Clientnamen oder nach den Rollen des Application Principal.
OAuth 2.0-Konfigurationsseite für Public API-Clients
1

Client benennen

Geben Sie im Feld Client Name einen Namen ein, der diesen Client identifiziert.
2

Secrets verwalten

Klicken Sie auf Add Secret, um ein neues Client-Secret zu erstellen. Standardmäßig läuft das neue Secret nach 6 Monaten ab — Sie können die Gültigkeitsdauer auf einen Zeitraum von 1 Tag bis 36 Monate festlegen.
3

Umleitungs-URLs hinzufügen

Klicken Sie auf Add Redirect URL und geben Sie jede URL ein, an die Autorisierungsumleitungen zulässig sein sollen.
4

OAuth 2.0-Flows konfigurieren

Wählen Sie im Abschnitt OAuth 2.0 Flows Settings einen oder mehrere Flows aus, die der Client verwenden kann:
  • Allow Authorization Code Flow — ein sicheres Authentifizierungsschema, bei dem die Anwendung die Authentifizierungsanforderung direkt an den Vantage-Autorisierungsserver sendet. Der Server überprüft die Anmeldedaten und gibt einen Autorisierungscode zurück. Dieser Flow ist für alle Vantage-API-Clients aktiviert.
    • Require PKCE for Authorization Code Flow — erhöht die Sicherheit für öffentliche Clients, indem Vantage überprüfen kann, ob die Anwendung, die das Zugriffstoken anfordert, dieselbe ist, die die Authentifizierung initiiert hat.
  • Allow Resource Owner Password Credentials Flow — ermöglicht Benutzern die Authentifizierung mit ihrem Benutzernamen und Kennwort. Die Anwendung hat direkten Zugriff auf das Kennwort des Benutzers. Verwenden Sie diese Option daher nur bei Anwendungen, denen der Benutzer vollständig vertraut.
  • Allow issuing refresh tokens to refresh access tokens — ermöglicht dem Client, Refresh-Tokens auszustellen, um Zugriffstokens zu erneuern, ohne den Benutzer dazu aufzufordern. Anwendungen müssen Refresh-Tokens sicher speichern.
  • Allow client credentials flow — gewährt Anwendungen über den OAuth 2.0 Client Credentials Flow Zugriff auf die Vantage-API. Die Rollen werden durch die Einstellung Manage Roles unterhalb dieser Option festgelegt.
Der Resource Owner Password Credentials Flow funktioniert nicht, wenn ein External Identity Provider konfiguriert ist. Siehe Authentication.
5

Token-Laufzeiten festlegen

Konfigurieren Sie im Abschnitt Token Lifetime Settings Folgendes:
  • Access Token — der Zeitraum, in dem ein ausgestelltes Zugriffstoken Zugriff auf Vantage gewährt. Standard: 24 Stunden.
  • Refresh Token — der absolute Zeitraum ab Ausstellung des ersten Zugriffstokens, in dem das Refresh-Token das Zugriffstoken erneuern kann. Standard: 30 Tage.
Weitere Informationen zu Authentifizierungsabläufen finden Sie unter Authentication.

​
Löschen eines Public-API-Clients

Zum Löschen eines Clients klicken Sie auf der Seite Public API-Client auf das Symbol und anschließend auf Delete Client.
Seite „Public API-Client“ mit der auf der Client-Symbolleiste hervorgehobenen Schaltfläche „Delete Client“

Vantage-API-Clients verwalten

Überblick über die Verwaltung von API-Clients in Ihrem Mandanten

Client mit der Vantage-API erstellen

Programmgesteuerte Alternative – Clients über die Admin-API erstellen

Authentifizierung

Anmeldeverfahren und OAuth 2.0-/SAML 2.0-Optionen