Übersicht über die Features der Microsoft Learn-Katalog-API
Die Microsoft Learn-Katalog-API ist eine REST-basierte Web-API, mit der Sie eine webbasierte Abfrage an Microsoft Learn senden und Informationen zu den verfügbaren Schulungsinhalten und Zertifizierungsexamen, z. B. deren Titel, die behandelten Produkte, Schwierigkeitsgrade, Links zum Schulungsinhalten und andere Metadaten abrufen können. Außerdem wird eine JSON-codierte Antwort mit den Informationen zurückgegeben.
Sie gibt Informationen zu allen öffentlich verfügbaren Daten zurück:
- Module
- Einheiten
- Lernpfade
- Angewandte Fähigkeiten
- Zertifizierungen
- Prüfungen
- Präsenzschulungen
Hinweis
Im Rahmen des aktuellen Updates der Website von Microsoft Learn wurde ein neuer Katalog-API-Endpunkt auf der Domain „learn.microsoft.com“ verfügbar. Der alte Endpunkt funktioniert weiterhin wie gewohnt. Wenn Sie jedoch zum neuen Endpunkt wechseln, können Sie erweiterte Features wie zusätzliche Abfrageparameter nutzen.
Anwendungsfälle
- Anzeigen von Metadaten zu Microsoft Learn-Schulungen und/oder Zertifizierungsangeboten
- Abrufen einer Liste der Microsoft Learn-Schulungen und/oder Zertifizierungsangebote, um sie mit der eigenen Onlineumgebung zu verknüpfen
Funktionsweise der Learn-Katalog-API
Bei der API handelt es sich dabei eine REST-basierte Web-API, die eine JSON-codierte Antwort zurückgibt. Um den vollständigen Katalog abzufragen, senden Sie eine GET-Anforderung an:
https://learn.microsoft.com/api/catalog/
Die Ausgabe sieht in etwa wie im folgenden Screenshot aus. Ab November 2022 hat die vollständige Antwort eine Größe von etwa 13 MB.
Jedes Lernkatalogelement ist ein Objekt, für das jeweils Metadaten verfügbar sind. Das vollständige Datenwörterbuch und andere Optionen sind in der Entwicklerdokumentation zur Microsoft Learn-Katalog-API aufgeführt. Außerdem finden Sie Versionshinweise (Link), in denen Sie die neuesten Updates und Informationen zu Best Practices finden.
Wenn Sie diese verwenden möchten, lesen Sie den Artikel Erste Schritte mit der Microsoft Learn-Katalog-API mit cURL und Visual Studio Code.
Anforderungen
Für den Zugriff auf die Microsoft Learn-Katalog-API ist keine Authentifizierung erforderlich. Benutzer*innen können ihre bevorzugte API-Anforderungsmethode verwenden, z. B. cURL oder Postman.
Beispiele
Im Folgenden finden Sie einige der vielen Möglichkeiten, wie Benutzer*innen die Learn-Katalog-API verwenden:
- Viva Learning nutzt die Learn-Katalog-API, um den Microsoft Learn-Katalog als Teil des Hauptangebots bereitzustellen.
- Organisationen und Bildungseinrichtungen verwenden die Learn-Katalog-API, um Kataloginformationen abzurufen und in ihren internen Lernverwaltungssystemen (Learning Management Systems, LMS) zu veröffentlichen, damit die Mitarbeiter*innen und Lernenden problemlos darauf zugreifen können.
- Bildungsanbieter verwenden die Learn-Katalog-API, um Kataloginformationen abzurufen und in ihre Lernangebote für Kunden einzubinden.
Verfügbarkeit und Preismodell
Die Katalog-API von Microsoft Learn ist öffentlich verfügbar und unterliegt den unter Microsoft APIs – Nutzungsbedingungen beschriebenen Bedingungen. Für die Verwendung der API fallen keine Gebühren an.
Einschränkungen
- Die API enthält öffentlich verfügbare Module, Einheiten, Lernpfade, Präsenzschulungen, Examen und Zertifizierungen. Derzeit werden keine Dokumentationen, Codebeispiele, Shows oder Events veröffentlicht.
- Die API wird mindestens einmal pro Tag aktualisiert.
- Updates der API-Version werden über Änderungen an den Versionshinweisen zur Learn-Katalog-API kommuniziert.
Nächste Schritte
Weitere Informationen zur Learn-Katalog-API finden Sie in den folgenden Artikeln: