Propósito
Cyber Guru ofrece la posibilidad de obtener información sobre la finalización de cursos por parte de la población presente en la plataforma, mediante una REST API que devuelve un conjunto de datos adecuado para ser utilizado por el cliente en sus propios LMS u otras plataformas.
La automatización de la adquisición de los datos proporcionados por Cyber Guru depende de los procesos y arquitecturas del cliente y, por este motivo, no puede ser supervisada por Cyber Guru.
Esta guía contiene las directrices y los parámetros para la invocación del servicio por parte del cliente.
Ámbito
La información se aplica a la plataforma de Concienciación en Ciberseguridad Cyber Guru 2.0.
Requisitos previos
-
El cliente debe tener los recursos tecnológicos para poder llamar a la REST API con una frecuencia
Procedimiento
Cyber Guru pone a disposición dos REST API:
Obtener token: https://login.platform.cyberguru.eu/realms/{TENANT}/protocol/openid-connect/token
Esta API permite obtener un token de autorización.
Parámetros de llamada (método POST):
-
client_id: ext-api
-
client_secret:
-
grant_types: client_credentials
Obtener datos del curso: https://<...>/</...>ext/training/completed-user-activities
que permite importar un subconjunto de datos de Cyber Guru a Workday.
Para poder invocar la API es necesario proporcionar el token obtenido en la API anterior como "Bearer token".
La API recibe los siguientes parámetros de entrada (método GET):
-
start_date (Opcional, formato YYYY-MM-DD)
-
end_date (Opcional, formato YYYY-MM-DD)
-
lang (Opcional)
La API devuelve los siguientes atributos en formato json:
|
Atributo |
Descripción |
|
Firstname |
Nombre del usuario |
|
Lastname |
Apellido del usuario |
|
|
Email del usuario |
|
Country |
País de origen del usuario |
|
Team |
Equipo al que pertenece el usuario |
|
Learning_Activity |
Nombre del módulo en el idioma especificado (o en el idioma predeterminado de la localización) |
|
Availability_Date |
Fecha de lanzamiento, es decir, la fecha en que se lanzó el curso (formato YYYY-MM-DD) |
|
Start_date |
Fecha en que el usuario comenzó el curso (formato YYYY-MM-DD) |
|
Time_Spent |
Tiempo, en formato hh:mm:ss, que el usuario ha utilizado/completado el curso |
|
Completion_Date |
Fecha en que el usuario completó por primera vez el curso (formato YYYY-MM-DD) |
|
Badge |
Campo booleano que vale 1 si el usuario ha obtenido un distintivo, de lo contrario 0 |
A continuación, el json de ejemplo de la respuesta:
{
"status": 200,
"data": [
{
"Firstname": "John",
"Lastname" : "Doe",
"Email": "name-test-1@mymail.com",
"Country": "UK",
"Team": "Red Ribbon",
"Learning_Activity": "Password",
"Registered_Date": "2024-03-06",
"Start_Date": "2024-03-17",
"Time_Spent": "00:22:35",
"Points": 12,
"Completion_Date": "2024-03-25",
"Badge": 1
},
{
"Firstname": "Donald",
"Lastname" : "Duck",
"Email": "name-test-2@mymail.com",
"Country": "U.S.A.",
"Team": "Duck Tales",
"Learning_Activity": "Phishing",
"Registered_Date": "2024-04-06",
"Start_Date": "2024-04-17",
"Time_Spent": "00:25:40",
"Points": 12,
"Completion_Date": "2024-04-29",
"Badge": 1
}
]
}
Cyber Guru está disponible para apoyar al cliente en la fase de configuración y prueba en un entorno de staging y, tras el resultado positivo de la prueba, en un entorno de producción.