Mit dem GET-API-Konnektor können Kunden Benutzerdaten abrufen, einschließlich Modulabschluss, Testergebnisse, Punktzahlen, Kursabschluss und Phishing-Daten. API-Schlüssel und API-Secret werden in Organisation bearbeiten erzeugt und stellen eine verschlüsselte Verbindung bereit.

Bitte beachten: Diese Funktion erfordert eine Freedom-Lizenz.

Die Implementierung des GET-API-Konnektors bietet mehrere Vorteile. Sie erlaubt eine effiziente Extraktion von Benutzerdaten und spart Zeit und Aufwand. Außerdem ermöglicht sie eine nahtlose Integration mit anderen Plattformen und verbessert die Gesamtleistung.

Die Konfiguration finden Sie im Menü Organisation bearbeiten.

Beispielkonfiguration

Kursabschluss nach Datum nach Benutzer

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)

Offene Schulungen abrufen

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")

Dieser Endpunkt liefert je Mitarbeitendem die noch nicht abgeschlossenen Schulungen, einschließlich Frist, ob sie verstrichen ist, der Anzahl der Tage im Rückstand und des Fortschritts. Mit overdue_only und due_before rufst du in einem Aufruf ab, wer im Rückstand ist. Mitarbeitende ohne offene Schulungen, inaktive Mitarbeitende und deaktivierte Kurse bleiben außen vor. Das vollständige Antwortformat steht in der API-Dokumentation.

Das API-Secret wird einmal angezeigt

Das API-Secret ist in der Plattform nicht auslesbar: es wird nur beim Anlegen einmal angezeigt. Bewahre es in dem Moment an einem sicheren Ort auf, zum Beispiel in einem Passwort-Tresor. Ist das Secret verloren, erzeuge unter Organisation bearbeiten ein neues; das alte funktioniert dann nicht mehr. Bestehende Verbindungen laufen weiter, solange du das Secret nicht erneuerst.