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.

Erstellen Sie API-Clients programmgesteuert, wenn Sie die Provisionierung automatisieren möchten — zum Beispiel als Teil von Infrastructure-as-Code oder bei der Integration mehrerer Apps in großem Umfang. Bevor Sie einen Client erstellen, authentifizieren Sie sich bei der Vantage-API. Weitere Informationen finden Sie unter Authentifizierung.

​
Erstellen eines Clients

Senden Sie eine POST-Anfrage mit dem Header Authorization: Bearer <access token> an {baseUrl}/api/adminapi2/v1/tenants/{tenantId}/clients/ und geben Sie dabei die folgenden Parameter im Request-Body an:
ParameterBeschreibung
clientIdDie Kennung des Clients.
clientNameDer Name des Clients (zum Beispiel der Name Ihrer App).
allowOfflineAccessGibt an, ob zusammen mit dem Zugriffstoken ein Refresh-Token generiert wird. Die Anwendung kann das Refresh-Token verwenden, um das Zugriffstoken ohne Benutzerinteraktion zu erneuern. Standard: false.
allowRememberConsentGibt an, ob der Benutzer entscheiden kann, Einwilligungsentscheidungen zu speichern. Standard: true.
backChannelLogoutSessionRequiredGibt an, ob der Backchannel-Logout-Mechanismus erforderlich ist. Standard: true.
requireClientSecretGibt an, ob ein Client-Secret erforderlich ist. Standard: true.
requireConsentGibt an, ob ein Einwilligungsbildschirm erforderlich ist. Standard: false.
allowNoPkceGibt an, ob der Authorization Code Flow ohne Proof Key for Code Exchange (PKCE) zulässig ist. Standard: false. Das bedeutet, dass nur der Authorization Code Flow mit PKCE zulässig ist.
allowedGrantTypesDie Grant-Typen, die der Client verwenden darf.
allowedCorsOriginsGibt an, ob der standardmäßige Cross-Origin Resource Sharing (CORS)-Mechanismus verwendet wird.
allowedScopesDie im Token übertragenen Scopes. Muss ein Array sein, das genau "openid", "permissions" und "publicapi.all" enthält.
postLogoutRedirectUrisEine Liste zulässiger URIs, zu denen nach der Abmeldung umgeleitet werden darf.
redirectUrisEine Liste von Website- oder App-URLs, die für Weiterleitungen des Autorisierungstokens auf die Zulassungsliste gesetzt sind. Präfixe sind zulässig — wenn ein Präfix übereinstimmt, ist jede URL darunter zulässig. Zum Beispiel: ["https://myDomain.", "https://myApp.myDomain.com/oauth-signin.html"].
accessTokenLifetimeDer Zeitraum, in dem ein ausgestelltes Zugriffstoken Zugriff auf Vantage gewährt. Standard: 24 Stunden.
refreshTokenLifetimeDer absolute Zeitraum ab Ausstellung des ersten Zugriffstokens, in dem das Refresh-Token zum Erneuern des Zugriffstokens verwendet werden kann. Standard: 30 Tage.
Wenn Sie sich mit Resource Owner Password Credentials (ROPC) authentifizieren, setzen Sie allowRopc auf true. Bei ROPC sendet der Benutzer seine Anmeldedaten direkt an die Anwendung. Verwenden Sie es daher nur für vertrauenswürdige vertrauliche Clients.

​
Beispielanfrage

curl --location --request POST '{baseUrl}/api/adminapi2/v1/tenants/{tenantId}/clients/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "{clientId}",
    "clientName": "{clientName}",
    "allowOfflineAccess": true,
    "allowRememberConsent": true,
    "backChannelLogoutSessionRequired": true,
    "requireClientSecret": true,
    "requireConsent": false,
    "allowNoPkce": true,
    "allowedGrantTypes": ["{allowedGrantTypes}"],
    "allowedCorsOrigins": ["{allowedCorsOrigins}"],
    "allowedScopes": ["openid", "permissions", "publicapi.all"],
    "postLogoutRedirectUris": ["{postLogoutRedirectUris}"],
    "redirectUris": ["{redirectUris}"]
  }'
Die Antwort enthält eine Beschreibung des neu erstellten Clients.

​
Erstellen eines Client-Secrets

Jeder Client kann mehrere Client-Secrets haben. Dadurch kann der Client ein neues Client-Secret verwenden, wenn das aktuelle abläuft, ohne das alte zu löschen. Standardmäßig läuft ein Client-Secret nach sechs Monaten ab. Senden Sie eine POST-Anfrage mit dem Header Authorization: Bearer <access token> an {baseUrl}/api/adminapi2/v1/tenants/{tenantId}/clients/{clientId}/secrets/ mit den folgenden Parametern im Request-Body:
ParameterBeschreibung
descriptionEine kurze Beschreibung, die Ihnen hilft, die Client-Secrets auseinanderzuhalten. Optional.
startTimeDas Startdatum des Client-Secrets.
expirationDas Ablaufdatum des Client-Secrets (zwischen 1 Tag und 3 Jahren). Zum Beispiel 2021-09-07T13:03:38.380Z. Standardmäßig wird dieses Datum auf exakt sechs Monate nach dem Erstellungsdatum des Client-Secrets gesetzt.

​
Beispielanfrage

curl --location --request POST '{baseUrl}/api/adminapi2/v1/tenants/{tenantId}/clients/{clientId}/secrets/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "description": "{description}",
    "startTime": "{startTime}",
    "expiration": "{expiration}"
  }'
Die Antwort enthält das Client-Secret (value) und seinen Gültigkeitszeitraum (startTime, expiration).
Der Wert des Client-Secret ist nur zum Zeitpunkt der Erstellung verfügbar. Speichern Sie ihn an einem sicheren Ort — später können Sie nur die ersten drei Zeichen des Werts (valueDisplay) einsehen.

Vantage-API-Clients verwalten

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

Public API-Client erstellen, konfigurieren und löschen

UI-Alternative — Clients in der Vantage-UI erstellen und konfigurieren

Mandanten über die Vantage-API erstellen

Programmatische Bereitstellung eines Mandanten

Authentifizierung

Anmeldeabläufe und Optionen für OAuth 2.0 / SAML 2.0