API abierta

En ASAP, puede usar una API abierta para interactuar con soluciones de terceros. La API abierta funciona a través de HTTP y ofrece un conjunto de métodos de solicitud/respuesta.

Las solicitudes de la API deben enviarse a la siguiente dirección:

<URL del portal de ASAP, que se utiliza para interactuar a través de la API abierta>/openapi/<versión de la API>/<solicitud>

Cómo obtener la URL de ASAP, que se utiliza para interactuar a través de la API

Para obtener una URL de la API abierta de ASAP:

1. Inicie sesión en la plataforma web ASAP.
2. En la sección Panel, haga clic en el botón Importar y sincronización y, a continuación, abra la pestaña API abierta.
3. El enlace para ponerse en contacto con ASAP a través de la API abierta está en la parte inferior de la ventana. Cópielo y guárdelo de la forma que sea más conveniente para usted.

Cómo activar el acceso a través de la API y generar un token

Para autorizar solicitudes, deben estar firmadas por un token creado en la plataforma ASAP. Solo los administradores de la empresa pueden crear tokens.

Para crear un token:

1. Inicie sesión en la plataforma web ASAP.
2. En la sección Panel, haga clic en el botón Importar y sincronización y, a continuación, abra la pestaña API abierta.
3. Haga clic en el botón Nuevo token.

   Se abrirá la ventana Obtener token.

4. Copie el token y guárdelo de la forma que sea más conveniente para usted.

El token no se almacena en el sistema de ASAP con acceso público. Después de cerrar la ventana Obtener un token, dejará de poder visualizarse. Si cerró la ventana sin copiar el token, tendrá que volver a hacer clic en Nuevo token para que el sistema genere uno nuevo.

El token emitido es válido durante 12 meses. Cuando pasa este período, el token se revoca. El token emitido también se revoca si no se usa en 6 meses.

Autorización

El token obtenido en ASAP tiene que añadirse a los encabezados de todas las solicitudes de la API. Este tendría que ser el aspecto del encabezado:

Formato de respuesta

JSON es el formato predeterminado para las respuestas a las solicitudes de la API.

Ejemplo de una llamada CURL

A continuación ve una solicitud de API a https://domain.com/, que utiliza el método «GET openapi/v1/groups» (obtener una lista de grupos). La solicitud se autentica con el token e8c699c05d495566a94bbb6841894153.

Métodos de la API abierta de ASAP utilizados para integrarse con sistemas de gestión de aprendizaje

Métodos disponibles de integración con los sistemas de gestión de aprendizaje:

1. /users/info: obtenga un enlace personal al portal del usuario.
2. /groups: obtenga una lista de los grupos disponibles para esta empresa.
3. /users: cree un usuario y añádalo al grupo especificado.
4. /report: genere datos de informes sobre los usuarios que están registrados en el portal y que están completando formación en los programas ASAP.
5. /user: haga cambios en los datos del usuario. Desplace a un empleado de la empresa a otro grupo de formación.

Cada método admite un máximo de 10 solicitudes por segundo.