Met de GET API-connector kunnen clients gebruikersgegevens ophalen, waaronder module-voltooiing, testscores, scores, voltooiing van cursussen en phishing-gegevens. De API-key en het API-secret worden gegenereerd in organisatie bewerken en bieden een versleutelde verbinding.

Let op: deze functionaliteit vereist een Freedom-licentie.

Het implementeren van de GET API-connector biedt verschillende voordelen. Je kunt eenvoudig en efficiënt gebruikersgegevens extraheren, wat tijd en moeite bespaart. Daarnaast maakt dit een naadloze integratie met andere platforms mogelijk, wat de totale ervaring verbetert.

Je vindt de configuratie in het menu organisatie bewerken.

Voorbeeld configuratie

Course completed by date by user

Path: https://portal.2lrn4.com/api/courses

Header:
api_key
api_secret

Parameters:
date_from (optional, string, format: \"Y-m-d\")
date_to (optional, string, format: \"Y-m-d\")
users (optional, array)

Response (example):
{
  \"status\": \"success\",
  \"message\": \"Complete courses\",
  \"data\": [
    {
      \"name\": \"John Doe\",
      \"email\": \"john@mail.test\",
      \"complete_courses\": [
        {
          \"course\": \"Test Course\",
          \"start_at\": \"2023-01-01\",
          \"end_at\": \"2023-01-01\",
          \"complete_at\": \"2023-01-01\"
        }
      ]
    }
  ]
}

Openstaande trainingen opvragen

Open trainings per user

Path: https://portal.2lrn4.com/api/courses/open

Header:
api_key
api_secret

Parameters:
overdue_only (optional, boolean)
due_before (optional, string, format: "Y-m-d")

Dit endpoint geeft per medewerker de trainingen die nog niet zijn afgerond, inclusief de deadline, of die al is verstreken, het aantal dagen te laat en de voortgang. Met overdue_only en due_before vraag je in één keer op wie er achterloopt. Medewerkers zonder openstaande trainingen, inactieve medewerkers en gedeactiveerde cursussen blijven buiten de lijst. Zie de API-documentatie voor het volledige antwoordformaat.

Het API-secret wordt één keer getoond

Het API-secret is in het platform niet terug te lezen: het wordt alleen bij het aanmaken één keer getoond. Bewaar het op dat moment op een veilige plek, bijvoorbeeld in een wachtwoordkluis. Ben je het secret kwijt, genereer dan in organisatie bewerken een nieuw secret; het oude stopt dan met werken. Bestaande koppelingen blijven gewoon werken zolang je het secret niet vernieuwt.