Die API-Endpunkte des LMS in der Swagger-Dokumentation lassen sich im Wesentlichen in drei verschiedene Kategorien unterteilen:
-
lms-calls
-
openlms-calls
-
systems-calls
Auf alle diese Endpunkte kann über die Basis-URL mit dem Zusatz /ils/restapi zugegriffen werden. Die URLs für diese drei Kategorien von Endpunkten lauten entsprechend:
-
{{baseUrl}}/ils/restapi/lms -
{{baseUrl}}/ils/restapi/openlms -
{{baseUrl}}/ils/restapi/systems
OpenLMS-Aufrufe erfordern keine Authentifizierung. LMS-Aufrufe erfordern hingegen entweder eine Basisauthentifizierung mit Nutzername und Passwort oder ein Bearer-Token mit Grant-Typ password, das auf verschiedene Weise generiert werden kann. Systemaufrufe können jedoch nur mit einem Bearer-Token mit Grant-Typ client_credentials verwendet werden.
Das IDM übernimmt das Identitätsmanagement innerhalb des LMS-Ökosystems. Um ein Bearer-Token zu erstellen, kann der folgende IDM-Endpunkt verwendet werden:
POST {{baseUrl}}/idm/oauth/token
Um ein Bearer-Token mit Grant-Typ password zu erhalten, muss der folgende x-www-form-urlencoded-Body bereitgestellt werden:
|
grant_type |
Passwort |
|
client_id |
|
|
client_secret |
|
|
Nutzername |
|
|
Passwort |
|
Für ein Bearer-Token mit Grant-Typ client_credentials ist der folgende Textkörper ausreichend, ebenfalls x-www-form-urlencoded:
|
grant_type |
|
|
client_id |
|
|
client_secret |
|
Sie können die client_id ILS, IDM oder ILP verwenden. Das entsprechende client_secret finden Sie in den Konfigurationsdateien Ihres Systems.
Beispielaufrufe zum Anfordern eines Bearer-Tokens finden Sie in dieser Postman-Collection:
Access tokens.postman_collection.json
Die Antwort, die den access_token enthält, ist immer ein JSON-Objekt mit den folgenden Feldern:
-
"access_token"
-
"token_type"
-
"expires_in"