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.

Cree clientes de API mediante programación cuando necesite automatizar el aprovisionamiento, por ejemplo, como parte de la infraestructura como código o al integrar varias aplicaciones a gran escala. Antes de crear un cliente, autorícese en Vantage API. Para obtener más información, consulte Autenticación.

​
Crear un cliente

Envíe una solicitud POST con el encabezado Authorization: Bearer <access token> a {baseUrl}/api/adminapi2/v1/tenants/{tenantId}/clients/ con los siguientes parámetros del cuerpo de la solicitud:
ParameterDescription
clientIdEl identificador del cliente.
clientNameEl nombre del cliente (por ejemplo, el nombre de su aplicación).
allowOfflineAccessIndica si se genera un token de actualización junto con el token de acceso. La aplicación puede usar el token de actualización para renovar el token de acceso sin intervención del usuario. Predeterminado: false.
allowRememberConsentIndica si el usuario puede optar por guardar sus decisiones de consentimiento. Predeterminado: true.
backChannelLogoutSessionRequiredIndica si el mecanismo Backchannel Logout es obligatorio. Predeterminado: true.
requireClientSecretIndica si se requiere un secreto de cliente. Predeterminado: true.
requireConsentIndica si se requiere una pantalla de consentimiento. Predeterminado: false.
allowNoPkceIndica si se permite el flujo de código de autorización sin Proof Key for Code Exchange (PKCE). Predeterminado: false, lo que significa que solo se permite el flujo de código de autorización con PKCE.
allowedGrantTypesLos tipos de concesión que el cliente puede usar.
allowedCorsOriginsIndica si se usa el mecanismo predeterminado de uso compartido de recursos entre orígenes (CORS).
allowedScopesLos ámbitos transferidos en el token. Debe ser un array que contenga exactamente "openid", "permissions" y "publicapi.all".
postLogoutRedirectUrisUna lista de URI permitidos a los que se redirige después del cierre de sesión.
redirectUrisUna lista de URL de sitios web o aplicaciones incluidas en la lista de permitidos para las redirecciones de tokens de autorización. Se permiten prefijos: si un prefijo coincide, se permite cualquier URL incluida en él. Por ejemplo: ["https://myDomain.", "https://myApp.myDomain.com/oauth-signin.html"].
accessTokenLifetimeEl período durante el cual un token de acceso emitido concede acceso a Vantage. Predeterminado: 24 horas.
refreshTokenLifetimeEl período absoluto, contado desde la emisión del primer token de acceso, durante el cual el token de actualización puede usarse para renovar el token de acceso. Predeterminado: 30 días.
Al autenticarse mediante Resource Owner Password Credentials (ROPC), establezca allowRopc en true. ROPC requiere que el usuario envíe sus credenciales directamente a la aplicación, así que úselo solo con clientes confidenciales de confianza.

​
Solicitud de ejemplo

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}"]
  }'
La respuesta incluye una descripción del cliente creado.

​
Creación de un secreto

Cada cliente puede tener varios secretos. Esto permite que el cliente comience a usar un nuevo secreto al vencer el actual, sin eliminar el anterior. De forma predeterminada, un secreto de cliente expira después de seis meses. Envíe una solicitud POST con el encabezado Authorization: Bearer <access token> a {baseUrl}/api/adminapi2/v1/tenants/{tenantId}/clients/{clientId}/secrets/ con los siguientes parámetros en el cuerpo de la solicitud:
ParámetroDescripción
descriptionUna descripción breve para ayudarle a distinguir entre los secretos. Opcional.
startTimeLa fecha de inicio del secreto.
expirationLa fecha de caducidad del secreto (entre 1 día y 3 años). Por ejemplo, 2021-09-07T13:03:38.380Z. De forma predeterminada, se establece exactamente seis meses después de la fecha de creación del secreto.

​
Solicitud de ejemplo

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}"
  }'
La respuesta contiene el secreto de cliente (value) y su periodo de validez (startTime, expiration).
El valor del secreto de cliente solo está disponible en el momento de su creación. Guárdelo en un lugar seguro; más adelante, solo podrá ver los tres primeros caracteres del valor (valueDisplay).

Gestión de clientes de la Vantage API

Información general sobre la gestión de clientes de API en su tenant

Crear, configurar y eliminar un cliente de API pública

Alternativa en la UI: crear y configurar clientes en la UI de Vantage

Crear un tenant mediante la Vantage API

Aprovisionamiento programático de tenants

Autenticación

Flujos de inicio de sesión y opciones de OAuth 2.0 / SAML 2.0