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.

Ein Systemadministrator kann einem Mandantenadministrator die Rolle „Fulfillment Operator“ zuweisen. Sobald die Rolle zugewiesen ist, kann der Mandantenadministrator über die Vantage-API neue Mandanten erstellen und diese Rolle anderen Benutzern in seinem Mandanten zuweisen. Um einen Mandanten über die Vantage-API zu erstellen, muss ein Fulfillment Operator Folgendes tun:
  1. Sich an der Vantage-API authentifizieren. Details finden Sie unter Authentication.
  2. Eine POST-Anfrage mit dem Header Authorization = Bearer <access token> an {baseUrl}/api/publicapi/v1/invites/ senden, mit folgenden Parametern im Request-Body:
ParameterBeschreibung
ModelEin Objekt, das die folgenden Parameter enthält: useMySubscription, email, tenantName, validWithin und tenantDescription.
emailE-Mail-Adresse des neu erstellten Mandantenadministrators.
validWithinZeitraum ab Versand, innerhalb dessen eine Einladung angenommen werden kann. Das Format ist days.hours:minutes:seconds. Der Standardwert ist 14.00:00:00 (14 Tage).
tenantNameName des Mandanten. Mandantennamen müssen eindeutig sein. Das Erstellen eines Mandanten mit einem bereits vorhandenen Namen führt zu einem Fehler.
useMySubscriptionGibt an, ob das Abonnement des aktuellen Mandanten wiederverwendet werden soll. Wenn aktiviert, verwenden sowohl der aktuelle als auch der neue Mandant denselben Seitenzähler. Wenn der Zähler von einem der Mandanten ausgeschöpft wird, können beide Mandanten ihn nicht mehr verwenden. Der Standardwert ist False, d. h. eine neue Abonnementdatei muss heruntergeladen werden.
tenantDescriptionBeschreibung des Mandanten. Dies kann ein beliebiger Text sein, der den Mandanten beschreibt, und wird dem Systemadministrator angezeigt.

​
Beispielanforderung

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'Model={
  "useMySubscription": false,
  "email": "test@test.com",
  "tenantName": "name",
  "validWithin": "14.00:00:00",
  "tenantDescription": "description"
}' \
  --form File='@example-file'

Mandantenverwaltung

Überblick über die Mandantenverwaltung in Vantage

Vantage-API-Clients verwalten

API-Clients für den neuen Mandanten bereitstellen

Einen Client mit der Vantage-API erstellen

Programmgesteuertes Erstellen eines API-Clients