Die Schulungstool-API ist eine REST-API, mit welcher Sie Daten in Ihrem Schulungstool-Konto einfach aus unserer Datenbank abrufen und verwalten können – zum Beispiel Kursteilnahmen auslesen oder Benutzer anlegen.

Die Schulungstool-API verfügt über Endpunkte mit ressourcenorientierten URLs. Sie akzeptiert für Anfragen die üblichen HTTP-Methoden GET, POST, PATCH und DELETE, gibt Antworten im JSON-Format zurück und verwendet die geläufigen HTTP-Statuscodes, um eine fehlerhafte Anfrage leicht von einer erfolgreichen Anfrage unterscheiden zu können.

Alle HTTP-Anfragen laufen über die Base-URL api.schulungstool.de.

Authentifizierung

Zur Authentifizierung nutzt Schulungstool API-Schlüssel.

Dieser Schlüssel muss in allen API-Anfragen im HTTP-Header enthalten sein. Die Zeile im HTTP-Header sollte wie folgt aussehen:

Authorization: Token <API-Schlüssel>

<API-Schlüssel> muss durch Ihren API-Schlüssel ersetzt werden.

Wer kann einen API-Schlüssel generieren?

Ein API-Schlüssel für den Zugriff auf die API kann von einem Administrator des Schulungstool-Kontos im Administrationsbereich unter Einstellungen > Erweiterte Einstellungen > Entwickleroptionen generiert werden.

Der Administrator muss den generierten API-Schlüssel den Nutzern der API auf eine sichere Art und Weise übermitteln.

Wenn Sie einen Administrator-Zugang zu Ihrem Schulungstool-Konto haben, können Sie schnell und einfach selbst einen API-Schlüssel generieren.

API-Schlüssel generieren

  1. Gehen Sie in Ihren Administrationsbereich und klicken Sie im Menü auf der linken Seite auf den Menüpunkt Einstellungen.
  2. Klicken Sie auf den Reiter Erweiterte Einstellungen.
  3. Klicken Sie im nun angezeigten linken Untermenü auf den Reiter Entwickleroptionen.
  4. Klicken Sie in der Tabelle API-Schlüssel auf den blauen Button API-Schlüssel generieren.
  5. Vergeben Sie im Dialogfenster einen aussagekräftigen Namen und klicken Sie auf API-Schlüssel generieren. Der generierte API-Schlüssel wird nur jetzt einmalig vollständig angezeigt.

Bitte speichern Sie den API-Schlüssel jetzt an einem sicheren Ort (z. B. in einem Passwortmanager). Geben Sie den API-Schlüssel nur an vertrauenswürdige Personen weiter.

Sie sind nun bereit, auf die API zuzugreifen und API-Anfragen zu stellen.

API-Dokumentation

Weitere Informationen zu allen Endpunkten, Anfrage- und Antwortformaten finden Sie in der API-Dokumentation unter docs.api.schulungstool.de.