| Parameter | Beschreibung |
|---|---|
| client_id | Die Anwendungskennung. Informationen zum Erstellen eines Vantage-API-Clients (client_id und client_secret) finden Sie im Artikel zur Verwaltung von Tenant Vantage API Clients. |
| redirect_uri | Die URL Ihrer Anwendung oder Website, an die der Browser weitergeleitet wird, sobald Zugriffsberechtigungen erteilt wurden. |
| response_type=code | Gibt an, dass der Antworttyp „authorization code“ verwendet wird. |
| scope=openid permissions global.wildcard | Gibt den Berechtigungsumfang an. |
| state | Ein beliebiger string-Wert, der das Autorisierungsergebnis in der Antwort enthält. |
| code_challenge | Digital signierter Wert des code_verifier (unter Verwendung der code_challenge_method). |
| code_challenge_method | Die Signaturmethode für den code_verifier (S256). |
| productId=a8548c9b-cb90-4c66-8567-d7372bb9b963 | Die Vantage-Kennung. |
Die Werte für response_type, scope, productId müssen genau wie oben angegeben sein. Diese Schlüssel – außer response_type – können sich ändern. Erwägen Sie, sie in der Konfiguration zu halten.Beispielanforderung Ein Parameter mit dem Namen redirect_uri, der den Bezeichner Ihrer Ressource enthält, wird in OAuth 2.0 verwendet, damit Vantage den Autorisierungscode an Ihre Ressource senden und diesen Code anschließend gegen das Zugriffstoken eintauschen kann, das für die Authentifizierung bei allen nachfolgenden API-Aufrufen erforderlich ist. Bei Verwendung dieser Authentifizierungsmethode muss der Wert des Parameters redirect_uri dem technischen Support von ABBYY bereitgestellt werden, damit er von den Administratoren auf die Allowlist gesetzt wird. Sobald die mit dem Parameter scope angeforderten Zugriffsberechtigungen als gewährt verifiziert wurden, wird der Browser auf eine spezielle Webseite weitergeleitet, die vom Vantage-Server bereitgestellt wird. Diese Webseite enthält ein Dialogfenster, über das Sie sich mit Ihrem Konto autorisieren. Diese Seite sollte in einem Browser geöffnet werden, der eine sichtbare Adressleiste hat, sodass Sie die Seiten-URL und den Status des SSL-Zertifikats der Verbindung überprüfen können. Wenn Ihre E-Mail-Adresse mit mehreren Konten in verschiedenen Tenants verknüpft ist, werden Sie aufgefordert, einen Tenant auszuwählen und Ihr Passwort einzugeben, nachdem Sie Ihre E-Mail-Adresse angegeben haben. Sie können Ihren Tenant-Bezeichner (den Parameter tokenId) auch direkt über eine der folgenden Ressourcen übermitteln: oder Sie werden aufgefordert, das Passwort für Ihr Mandantenkonto einzugeben. Nachdem Sie Ihre Anmeldedaten eingegeben haben, wird die Autorisierung serverseitig abgeschlossen, die Anwendung erhält Zugriff auf die Vantage-API, und Sie erhalten den Autorisierungscode in der Antwort auf Ihre Anfrage. Bitte beachten Sie, dass Vantage-Benutzer, wenn eine Website oder Anwendung diesen Authentifizierungstyp verwendet, dieser Website oder App, die Sie zur Liste der zulässigen Redirect-URLs hinzufügen, in ihrem Namen Zugriff auf die Vantage-API gewähren. Um der Website oder App Zugriff zu gewähren, werden Benutzer aufgefordert, sich mit ihrem Benutzernamen und Passwort in Vantage zu authentifizieren. Sobald ein Benutzer authentifiziert ist, erhält die Website oder App die folgenden Berechtigungen:
- Verwalten von Datenkatalogen im Vantage-Tenant im Namen des Benutzers,
- Zugriff auf Skills im Vantage-Tenant im Namen des Benutzers,
- Erstellen von und Zugriff auf Vantage-Vorgänge im Namen des Benutzers.
application/x-www-form-urlencoded.
Parameter des Anfragetexts:
| Parameter | Beschreibung |
|---|---|
| code_verifier | Der von Ihnen generierte Code. Wird benötigt, um die Einleitung der Autorisierungsanfrage zu bestätigen. |
| client_id | Die Anwendungs-ID. |
| client_secret | Sicherer Anwendungsschlüssel. |
| code | Ihr vom Server erhaltener Autorisierungscode. |
| redirect_uri | Die in Schritt „authorize“ verwendete Weiterleitungs-URL. |
| grant_type=authorization_code | Gibt an, dass der Grant-Typ „authorization code“ verwendet wird. |
| scope=openid permissions global.wildcard offline_access | Gibt den Berechtigungsumfang an. Um ein Aktualisierungstoken zu erhalten, fügen Sie offline_access zum Scope hinzu. |
token durch den von Ihnen erhaltenen Wert:
Abrufen des Refresh-Tokens
Allow issuing refresh tokens to refresh access tokens bei der Konfiguration des Vantage-API-Clients aktiviert war und die Anforderung zum Abrufen des Access-Tokens den Parameter scope=openid permissions global.wildcard offline_access enthielt, erhalten Sie in der Antwort zusätzlich ein Refresh-Token. Sobald Sie ein Refresh-Token haben, können Sie das Access-Token mit einer POST-Anforderung an den Token-Endpunkt und den folgenden Parametern aktualisieren:
| Parameter | Beschreibung |
|---|---|
| client_id | Die Anwendungs-ID. |
| client_secret | Ein sicherer Anwendungsschlüssel. |
| refresh_token | Ihr vom Server erhaltenes Refresh-Token. |
| grant_type=refresh_token | Gibt an, dass der Grant-Typ „refresh_token“ verwendet wird. |
Tokenlaufzeiten
- Laufzeit des Access-Tokens: Definiert den Zeitraum, in dem das ausgegebene Access-Token dem Benutzer Zugriff auf Vantage gewährt. Die Standardlaufzeit eines Access-Tokens beträgt 24 Stunden.
- Laufzeit des Refresh-Tokens: Definiert den absoluten Zeitraum ab der Ausstellung des ersten Access-Tokens, in dem das ausgegebene Refresh-Token verwendet werden kann, um das Access-Token zu erneuern. Die Standardlaufzeit eines Refresh-Tokens beträgt 30 Tage.