Cómo acceder a la API

Registre una aplicación en el Back Office de B2CORE IB, elija su nivel de acceso, intercambie las credenciales por un token de acceso y llame a la API de IB

Las integraciones acceden a la API de B2CORE IB en nombre de una aplicación registrada en el Back Office. Cada aplicación tiene un ID de cliente, un secreto de cliente y un nivel de acceso que determina si puede modificar datos. En este artículo se explica cómo registrar una aplicación y realizar su primera llamada a la API.

Registrar una aplicación

Vaya a Brókeres introductores > Preferencias > Aplicaciones.

Haga clic en Registrar una nueva aplicación.

Indique un nombre en el campo Nombre de la aplicación.

Seleccione el Nivel de acceso:

  • Read-only (preseleccionado): la aplicación puede llamar a todas las operaciones GET y crear trabajos de exportación; se rechaza cualquier otra solicitud POST, PUT, PATCH o DELETE realizada con el token de acceso de la aplicación. Se recomienda para integraciones de informes y supervisión.
  • Full access: la aplicación puede llamar a todas las operaciones de la API.

Puede cambiar el nivel de acceso más adelante en la página de detalles de la aplicación. El cambio se aplica a la siguiente solicitud de la aplicación a la API.

Haga clic en Guardar.

Se le redirigirá a la página de detalles de la aplicación recién creada, donde podrá ver el Nombre de la aplicación, el ID de cliente, el Secreto de cliente, el Nivel de acceso y la Lista de IP permitidas.

Copie su ID de cliente y su Secreto de cliente y guárdelos en un lugar seguro. Se utilizan para verificar su identidad al acceder a la API. El secreto de cliente se muestra una sola vez, en esta página; no podrá volver a verlo.

Obtener un token de acceso

Envíe una solicitud POST a la operación /tokens mediante autenticación HTTP Basic, con el ID de cliente como nombre de usuario y el Secreto de cliente como contraseña:

curl -X POST "{baseUrl}/tokens" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"grant_type": "client_credentials"}'

Sustituya {baseUrl} por la URL base de su API de IB, proporcionada por su equipo de integración de B2BROKER.

Copie el valor de access_token de la respuesta. La respuesta también contiene token_type (Bearer) y expires_in, que indica la duración del token en segundos. Al solicitar un nuevo token, se revocan los tokens anteriores de la aplicación.

Llamar a la API

Incluya el token en la cabecera Authorization de cada solicitud:

curl "{baseUrl}/users" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Todas las operaciones figuran en la referencia de la API. Cada operación indica el acceso que requiere: read (disponible para todas las aplicaciones) o write (solo para aplicaciones con Full access).

Qué significa una respuesta 403

Si una aplicación con Read-only llama a una operación que requiere acceso write, la API rechaza la solicitud con HTTP 403 y el siguiente cuerpo:

{
  "error": {
    "message": "This App is read-only and cannot perform this operation.",
    "code": "insufficient_scope"
  }
}

Compruebe el campo code: insufficient_scope indica que la causa es el nivel de acceso de la aplicación. Para que la solicitud se realice correctamente, cambie la aplicación a Full access en Brókeres introductores > Preferencias > Aplicaciones —el cambio se aplica a la siguiente solicitud y no necesita un nuevo token— o registre otra aplicación con Full access para la integración que necesita modificar datos.

La única excepción es POST /exports/async: las aplicaciones con Read-only pueden crear trabajos de exportación, por lo que las integraciones de informes pueden exportar datos sin Full access.

Última actualización

En esta página