Client Credentials-Flow

Dieses Authentifizierungsverfahren ermöglicht einer Anwendung, ein Zugriffstoken zu erhalten, indem ihre Anmeldeinformationen wie Client-ID und Client-Secret ausgetauscht werden. Dieser Flow eignet sich besonders für Machine-to-Machine-(M2M)-Anwendungen, einschließlich Ihrer Anwendung oder Backend-Services, da er die Authentifizierung und Autorisierung der Anwendung selbst ermöglicht statt der eines Benutzers.

Dieser Flow funktioniert nur, wenn die Option Client Credentials-Flow zulassen für Ihren API-Client aktiviert ist (Konfiguration > Public API-Client). Die Berechtigungen des Tokens stammen von den Rollen, die dem API-Client auf demselben Bildschirm zugewiesen sind; für den Aufruf von Reporting-API-Endpunkten ist die Rolle Mandantenadministrator oder Verarbeitungsaufsicht erforderlich. Ein Client ohne aktivierte Option erhält vom Token-Endpunkt {"error":"invalid_client"}.

Um das Zugriffstoken zu erhalten, verwenden Sie Folgendes:

Eine POST-Anfrage.

Die Ressource token Ihrer Mandantenregion:

https://vantage-us.abbyy.com/auth2/connect/token

https://vantage-eu.abbyy.com/auth2/connect/token

https://vantage-au.abbyy.com/auth2/connect/token

Einen Content-Type-Header mit der Codierung application/x-www-form-urlencoded.
Einen Anfragetext mit den folgenden Parametern:

Parameter	Beschreibung
client_id	Anwendungskennung.
client_secret	Sicherer Anwendungsschlüssel.
grant_type=client_credentials	Gibt an, dass der Grant-Typ „Client Credentials“ verwendet wird.
scope=openid permissions global.wildcard	Gibt den Berechtigungsumfang an.

Beispielanfrage: Für Windows:

curl --location --request POST "https://vantage-us.abbyy.com/auth2/connect/token" \
  --data-urlencode "client_id=client_id" \
  --data-urlencode "client_secret=client_secret" \
  --data-urlencode "grant_type=client_credentials" \
  --data-urlencode "scope=openid permissions global.wildcard"

curl --location --request POST "https://vantage-eu.abbyy.com/auth2/connect/token" \
  --data-urlencode "client_id=client_id" \
  --data-urlencode "client_secret=client_secret" \
  --data-urlencode "grant_type=client_credentials" \
  --data-urlencode "scope=openid permissions global.wildcard"

curl --location --request POST "https://vantage-au.abbyy.com/auth2/connect/token" \
  --data-urlencode "client_id=client_id" \
  --data-urlencode "client_secret=client_secret" \
  --data-urlencode "grant_type=client_credentials" \
  --data-urlencode "scope=openid permissions global.wildcard"

Für Linux:

curl --location --request POST 'https://vantage-us.abbyy.com/auth2/connect/token' \
  --data-urlencode 'client_id=client_id' \
  --data-urlencode 'client_secret=client_secret' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'scope=openid permissions global.wildcard'

curl --location --request POST 'https://vantage-eu.abbyy.com/auth2/connect/token' \
  --data-urlencode 'client_id=client_id' \
  --data-urlencode 'client_secret=client_secret' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'scope=openid permissions global.wildcard'

curl --location --request POST 'https://vantage-au.abbyy.com/auth2/connect/token' \
  --data-urlencode 'client_id=client_id' \
  --data-urlencode 'client_secret=client_secret' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'scope=openid permissions global.wildcard'

Die Antwort des Servers auf Ihre Anfrage enthält das Zugriffstoken:

{
  "access_token": "<redacted>",
  "expires_in": 86400,
  "token_type": "Bearer",
  "scope": "openid permissions global.wildcard"
}

Weitere Informationen zu Client Credentials finden Sie unter diesem Link.

Übersicht

Entwicklerhandbuch