Saltar al contenido principal

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.

Un administrador del sistema puede asignar el rol de Fulfillment Operator a un administrador del tenant. Una vez asignado, el administrador del tenant puede crear nuevos tenants a través de la API de Vantage y otorgar este rol a otros usuarios de su tenant. Para crear un tenant mediante la API de Vantage, un Fulfillment Operator debe:
  1. Autenticarse en la API de Vantage. Para más detalles, consulte Authentication.
  2. Enviar una solicitud POST con el encabezado Authorization = Bearer <access token> a {baseUrl}/api/publicapi/v1/invites/, con los siguientes parámetros en el cuerpo de la solicitud:
ParameterDescription
ModelUn objeto que contiene los siguientes parámetros: useMySubscription, email, tenantName, validWithin y tenantDescription.
emailEl correo electrónico del nuevo administrador del tenant.
validWithinTiempo desde el momento del envío durante el cual se puede aceptar una invitación. El formato es days.hours:minutes:seconds. El valor predeterminado es 14.00:00:00 (14 días).
tenantNameEl nombre del tenant. Los nombres de tenant deben ser únicos. Si se intenta crear un tenant con un nombre que ya existe, se generará un error.
useMySubscriptionIndica si se debe reutilizar la suscripción del tenant actual. Si está habilitado, tanto el tenant actual como el nuevo comparten el mismo contador de uso de páginas. Cuando el contador se agota por cualquiera de los tenants, ambos dejan de poder utilizarlo. El valor predeterminado es False, lo que significa que se debe descargar un nuevo archivo de suscripción.
tenantDescriptionLa descripción del tenant. Puede ser cualquier texto que describa el tenant y será visible para el administrador del sistema.

Ejemplo de solicitud

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'

Gestión de tenants

Información general sobre la administración de tenants en Vantage

Gestionar clientes de la Vantage API

Aprovisionamiento de clientes de API para el nuevo tenant

Crear un cliente con la Vantage API

Creación programática de clientes de API