Open API

In ASAP können Sie Open API nutzen, um mit Drittanbieter-Lösungen zu interagieren. Open API läuft über HTTP und bietet ein Paket von Anfrage/Antwort-Methoden.

API-Anfragen müssen an die folgende Adresse gesendet werden:

<URL des ASAP-Portals, das für die Interaktion über Open API verwendet wird>/openapi/<API-Version>/<Anfrage>

So erhalten Sie die API-URL, die zur Interaktion über die API verwendet wird

So erhalten Sie eine ASAP Open API-URL:

1. Melden Sie sich bei der ASAP-Webplattform an.
2. Klicken Sie im Abschnitt Dashboard auf die Schaltfläche Import und Synchronisierung und öffnen Sie dann die Registerkarte Open API.
3. Der Link zur Kontaktierung von ASAP über Open API befindet sich im unteren Fensterbereich. Kopieren Sie den Token und speichern Sie ihn auf passende Weise.

So aktivieren Sie den Zugang über die API und erzeugen einen Token

Um Anfragen zu autorisieren, müssen sie durch einen Token signiert sein, der auf der ASAP-Plattform erzeugt wurde. Nur der Administrator des Unternehmens kann Token erzeugen.

So erstellen Sie einen Token:

1. Melden Sie sich bei der ASAP-Webplattform an.
2. Klicken Sie im Abschnitt Dashboard auf die Schaltfläche Import und Synchronisierung und öffnen Sie dann die Registerkarte Open API.
3. Klicken Sie auf die Schaltfläche Neuer Token.

   Das Fenster Token abrufen wird geöffnet.

4. Kopieren Sie das Token und speichern Sie es auf passende Weise.

Das Token wird nicht im öffentlich zugänglichen ASAP-System gespeichert. Nachdem das Fenster Token abrufen geschlossen wurde, kann es nicht mehr angezeigt werden. Wenn Sie dieses Fenster geschlossen haben, ohne das Token zu kopieren, müssen Sie erneut auf Neues Token drücken, damit das System ein neues Token generiert.

Der ausgegebene Token ist 12 Monate gültig. Wenn dieser Zeitraum abgelaufen ist, wird der Token zurückgezogen. Wenn der ausgegebene Token 6 Monate lang nicht benutzt wird, wird er ebenfalls zurückgezogen.

Autorisierung

Der auf ASAP erhaltene Token muss in allen API-Anfragen zur Kopfzeile hinzugefügt werden. Die Kopfzeile muss wie folgt aussehen:

Antwortformat

JSON ist das Standardformat für Antworten auf API-Anfragen.

Beispiel eines CURL-Aufrufs

Nachstehend finden Sie eine API-Anfrage an https://domain.com/, in der die „GET openapi/v1/groups“-Methode (Liste von Gruppen erhalten) verwendet wird. Die Anfrage authentifiziert mithilfe des Tokens e8c699c05d495566a94bbb6841894153.

ASAP Open API-Methoden, die zur Integration mit Learning Management Systems (LMSs) verwendet werden

Verfügbare Methoden zur Integration mit Learning Management Systems:

1. /users/info – persönlichen Link zum Benutzerportal anfordern.
2. /groups –Liste von Gruppen erhalten, die für dieses Unternehmen verfügbar sind.
3. /users – Benutzer erstellen und zur angegebenen Gruppe hinzufügen.
4. /report – Berichtsdaten über Benutzer generieren, die im Portal registriert sind und Trainings in ASAP-Programmen abschließen.
5. /user – Änderungen an Benutzerdaten durchführen. Einen Mitarbeiter des Unternehmens in eine andere Trainingsgruppe verschieben.

Jede Methode unterstützt höchstens 10 Anfrage pro Sekunde (RPS).