Omówienie funkcji interfejsu API wykazu usługi Microsoft Learn
Interfejs API wykazu usługi Microsoft Learn to internetowy interfejs API oparty na protokole REST, który umożliwia wysyłanie zapytania internetowego do usługi Microsoft Learn i uzyskiwanie szczegółowych informacji na temat dostępnej zawartości szkoleniowej i egzaminów certyfikacyjnych, takich jak tytuły, produkty objęte, poziomy, linki do trenowania oraz inne metadane i zwraca zakodowaną w formacie JSON odpowiedź z informacjami.
Zwraca informacje o wszystkich dostępnych publicznie elementach:
- Moduły
- Jednostki
- Ścieżki szkoleniowe
- Zastosowane umiejętności
- Certyfikaty
- Egzaminy
- Kursy prowadzone przez instruktora
Uwaga
W ramach najnowszej aktualizacji witryny microsoft Learn dostępny jest nowy punkt końcowy interfejsu API wykazu dostępny w domenie learn.microsoft.com. Stary punkt końcowy będzie nadal działać zgodnie z oczekiwaniami, ale korzyści wynikające z przełączenia do nowego punktu końcowego to zapewnienie rozszerzonych funkcji, takich jak dodatkowe parametry zapytania.
Przypadki użycia
- Wyświetlanie metadanych dotyczących szkoleń i/lub ofert certyfikacji usługi Microsoft Learn
- Pobierz listę ofert szkoleń i/lub certyfikatów usługi Microsoft Learn, aby połączyć się z nimi z własnego środowiska online
Jak działa interfejs API wykazu usługi Learn
Interfejs API to internetowy interfejs API oparty na protokole REST, który zwraca odpowiedź zakodowaną w formacie JSON. Aby zażądać pełnego wykazu, wyślij żądanie GET do:
https://learn.microsoft.com/api/catalog/
Dane wyjściowe będą wyglądać podobnie jak na poniższym zrzucie ekranu. Od listopada 2022 r. pełna odpowiedź wynosi około 13 MB.
Każdy element katalogu szkoleniowego jest obiektem z zestawem metadanych dostępnych dla każdego z nich. Pełny słownik danych i inne opcje są wymienione w dokumentacji deweloperów interfejsu API wykazu usługi Microsoft Learn. Mamy również informacje o wersji (link), aby zobaczyć, jakie są najnowsze aktualizacje, oraz informacje o najlepszych rozwiązaniach .
Jeśli chcesz go używać, zapoznaj się z artykułem Wprowadzenie do interfejsu API wykazu usługi Microsoft Learn przy użyciu biblioteki cURL i programu Visual Studio Code.
Wymagania
Nie ma uwierzytelniania wymaganego do uzyskania dostępu do interfejsu API wykazu usługi Microsoft Learn. Użytkownicy mogą używać preferowanej metody żądania interfejsu API, takiej jak cURL, Postman itp.
Przykłady
Poniżej przedstawiono kilka z wielu sposobów, na które użytkownicy korzystają z interfejsu API wykazu platformy Learn:
- Viva Edukacja użyła interfejsu API wykazu platformy Learn do zaoferowania katalogu usługi Microsoft Learn w ramach podstawowego środowiska.
- Organizacje i instytucje edukacyjne używają interfejsu API katalogu usługi Learn do ściągania informacji katalogu i publikowania ich w wewnętrznych systemach zarządzania nauką (LMS), dzięki czemu pracownicy i uczniowie mogą łatwo uzyskać do niego dostęp.
- Edukacja dostawcy używają interfejsu API wykazu usługi Learn do ściągania informacji katalogu i publikowania ich w środowiskach szkoleniowych klientów.
Dostępność i cennik
Interfejs API wykazu usługi Microsoft Learn jest publicznie dostępny i oferowany w ramach warunków użytkowania interfejsów API firmy Microsoft. Korzystanie z interfejsu API nie jest naliczane żadne opłaty.
Ograniczenia
- Interfejs API zawiera publicznie dostępne moduły, jednostki, ścieżki szkoleniowe, kursy prowadzone przez instruktora, egzaminy i certyfikaty. Obecnie nie generuje dokumentacji, przykładów kodu, pokazów ani zdarzeń.
- Interfejs API odświeża co najmniej jeden raz dziennie.
- Aktualizacje wersji interfejsu API będą przekazywane za pośrednictwem aktualizacji do Informacje o wersji interfejsu API wykazu.
Następne kroki
Aby dowiedzieć się więcej na temat interfejsu API wykazu platformy Learn, zapoznaj się z następującymi artykułami: