So autorisieren Sie sich mit einem API-Schlüssel bei der Learn365-API

Einführung

Zum Verwenden der Learn365-API müssen Benutzer sich mit einem passenden API-Schlüssel autorisieren.

Dieser Artikel beschreibt, wo Sie einen API-Schlüssel erhalten und wie Sie sich damit bei der Learn365-API in Swagger oder Postman autorisieren.

Learn365-API-Schlüssel zur Autorisierung abrufen

Erforderliche Rolle: LMS-Administrator oder globaler Microsoft 365-Administrator

Learn365 ermöglicht globalen Administratoren, mehrere Learn365-API-Schlüssel zu generieren mit zwei Berechtigungsstufen - schreibgeschützt und Vollzugriff. 

So rufen Sie den API-Schlüssel mit der entsprechenden Berechtigungsstufe ab:

1. Gehen Sie zu Learn365 Admin Center > All catalogs > Administration > API-Schlüsselverwaltung.

2. Swählen Sie den API-Schlüssel aus, und kopieren Sie ihn mit der Option API-Schlüssel kopieren.

Der API-Schlüssel wird für die Autorisierung bei der Learn365-API verwendet.

In Swagger bei der Learn365-API autorisieren

Nachdem Sie den erforderlichen API-Schlüssel abgerufen haben, können Sie damit den Zugriff auf die Learn365-API in Swagger autorisieren.

1. Gehen Sie zu https://api.365.systems und navigieren Sie zu Learn365 Cloud API.

2. Wählen Sie entweder Authorize oder das Schlosssymbol des API-Endpunkts aus, den Sie verwenden werden. Die Seite Available authorizations wird geöffnet.

3. Führen Sie auf der geöffneten Seite Available authorizations unter Basic authorization die folgenden Schritte durch:

• Geben Sie im Feld Username das Wort api oder apikey ein.
• Fügen Sie im Feld Password den Learn365-API-Schlüssel ein, den Sie zuvor kopiert haben.

4. Wählen Sie Authorize aus, um mit der Autorisierung fortzufahren. Um den Vorgang abzubrechen, wählen Sie Close.

So melden Sie sich nach erfolgter Autorisierung bei der Learn365-API ab:

1. Wählen Sie entweder Authorize oder das Schloss-Symbol des entsprechenden API-Endpunkts aus. Die Seite Available authorizations wird geöffnet.

2. Wählen Sie auf der geöffneten Seite Available authorizations die Schaltfläche Logout aus.

Bei Postman autorisieren

So autorisieren Sie sich bei Postman:

1. Navigieren Sie zur Registerkarte Autorisierung tab.

2. Wählen Sie im Type Drop-down-Menü Basic Auth aus.

3. Füllen Sie die Felder Benutzername und Passwort aus:

• Geben Sie im Feld Benutzername das Wort api oder apikey ein.
• Fügen Sie im Feld Passwort den API-Schlüssel ein, den Sie zuvor kopiert haben.

4. Wählen Sie Senden aus.

Die Autorisierungsdaten werden automatisch eingebunden und dann bei jeder Anfrage gesendet.