Objectif
Cyber Guru offre la possibilité d'acquérir des informations sur l'achèvement des cours par la population présente sur la plateforme, via une API REST qui renvoie un ensemble de données approprié pour être utilisé par le client dans ses propres LMS ou autres plateformes.
L'automatisation de l'acquisition des données fournies par Cyber Guru dépend des processus et des architectures du client et, pour cette raison, ne peut pas être supervisée par Cyber Guru.
La présente ligne directrice contient les directives et les paramètres pour l'invocation du service par le client.
Champ d'application
Les informations s'appliquent à la plateforme de sensibilisation à la cybersécurité Cyber Guru 2.0.
Prérequis
-
Le client doit disposer des ressources technologiques pour pouvoir appeler l'API REST à une fréquence
Procédure
Cyber Guru met à disposition deux API REST :
Obtenir un token : https://login.platform.cyberguru.eu/realms/{TENANT}/protocol/openid-connect/token
Cette API permet d'obtenir un jeton d'autorisation.
Paramètres d'appel (méthode POST) :
-
client_id : ext-api
-
client_secret :
-
grant_types : client_credentials
Obtenir les données de cours : https://<...>/</...>ext/training/completed-user-activities
qui permet d'importer un sous-ensemble de données de Cyber Guru à Workday.
Pour pouvoir invoquer l'API, il est nécessaire de fournir le jeton obtenu dans l'API précédente comme "Bearer token".
L'API prend en entrée les paramètres suivants (méthode GET) :
-
start_date (Optionnel, format YYYY-MM-DD)
-
end_date (Optionnel, format YYYY-MM-DD)
-
lang (Optionnel)
L'API retourne les attributs suivants au format json :
|
Attribut |
Description |
|
Firstname |
Prénom de l'utilisateur |
|
Lastname |
Nom de l'utilisateur |
|
|
Email de l'utilisateur |
|
Country |
Pays d'origine de l'utilisateur |
|
Team |
Équipe d'appartenance de l'utilisateur |
|
Learning_Activity |
Nom du module dans la langue spécifiée (ou dans la langue par défaut de secours de la localisation) |
|
Availability_Date |
Date de publication, c'est-à-dire la date à laquelle le cours a été publié (format YYYY-MM-DD) |
|
Start_date |
Date à laquelle l'utilisateur a commencé le cours (format YYYY-MM-DD) |
|
Time_Spent |
Temps, au format hh:mm:ss, pendant lequel l'utilisateur a suivi/complété le cours |
|
Completion_Date |
Date à laquelle l'utilisateur a terminé le cours pour la première fois (format YYYY-MM-DD) |
|
Badge |
Champ booléen qui vaut 1 si l'utilisateur a obtenu un badge, sinon 0 |
Voici un exemple de réponse en json :
{
"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 pour accompagner le client lors de la phase de configuration et de test sur un environnement de staging et, après un test concluant, en environnement de production.