Vai al contenuto principale
Novità! Clicca qui
Accedi
Deutsch English (United States) Español Français

Estrazione dati completamento corsi per LMS generico

  • Aggiornato

Scopo

Cyber Guru offre la possibilità di acquisire informazioni di completamento corsi da parte della popolazione presente in piattaforma, mediante una REST API che restituisce un set di dati idoneo per essere utilizzato dal cliente in propri LMS o altre piattaforme.

L’automazione dell’acquisizione dei dati forniti da Cyber Guru dipende da processi e architetture del cliente e per questo motivo non può essere presidiata da Cyber Guru.

La presente linea guida contiene le direttive e i parametri per l’invocazione del servizio da parte del cliente.

Ambito

Le informazioni si applicano alla piattaforma di Cyber Security Awareness Cyber Guru 2.0.

Prerequisiti

  • Il cliente deve avere le risorse tecnologiche per poter chiamare REST API con una frequenza

Procedura

Cyber Guru mette a disposizione due REST API :

Get token : https://login.platform.cyberguru.eu/realms/{TENANT}/protocol/openid-connect/token

Questa API consente di ottenere un token di autorizzazione.

Parametri di chiamata (metodo POST):

  • client_id : ext-api
  • client_secret :
  • grant_types : client_credentials

Get course data : https://<...>/</...>ext/training/completed-user-activities

che consente di importare un subset di dati da Cyber Guru a Workday.

Per poter invocare l’API è necessario fornire il token ottenuto nella precedente API come "Bearer token".

L’API prende in ingresso i seguenti parametri (metodo GET):

  • start_date (Obbligatorio, format YYYY-MM-DD)
  • end_date (Obbligatorio, format YYYY-MM-DD)
  • lang (Opzionale)

L'API ritorna i seguenti attributi in formato json:

Attributo Descrizione
Firstname Nome utente
Lastname Cognome utente
Email Email utente
Country Paese di provenienza dell'utente
Team Team di appartenenza dell'utente
Learning_Activity Nome del modulo nella lingua specificata (o nella lingua di default del fallback da Localization)
Availability_Date Release date cioe' data in cui e' stato rilasciato il corso (formato YYYY-MM-DD)
Start_date Data in cui l’utente ha iniziato il corso (formato YYYY-MM-DD)
Time_Spent Tempo, nel formato hh:mm:ss, nel quale l’utente ha usufruito/completato il corso
Completion_Date data in cui l’utente ha completato per la prima volta il corso (formato YYYY-MM-DD)
Badge Campo booleano che vale 1 se l’utente ha ottenuto un badge altrimenti 0

Di seguito il json di esempio della response:

{
    "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 è a disposizione per supportare il cliente nella fase di configurazione e di test su un ambiente di staging e, a valle dell’esito positivo del test, in ambiente di produzione.

Articoli correlati