Omówienie funkcji interfejsu API katalogu 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 elementach dostępnych publicznie:

• Modules
• Units
• Ścieżki szkoleniowe
• Zastosowane umiejętności
• Certifications
• Egzaminów
• Kursy Prowadzone przez Instruktora

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 oparty na REST, który zwraca odpowiedź 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 API dla deweloperów katalogu 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.

Requirements

Nie jest wymagane uwierzytelnianie do uzyskania dostępu do interfejsu API katalogu Microsoft Learn. Użytkownicy mogą używać preferowanej metody żądania interfejsu API, takiej jak cURL, Postman itp.

Przykłady

Poniżej przedstawiono kilka spośród wielu sposobów, w jaki użytkownicy korzystają z API katalogu Learn.

• Aplikacja Viva Learning użyła interfejsu API katalogu Learn do zaoferowania katalogu Microsoft Learn jako część podstawowego doświadczenia.
• 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.
• Dostawcy usług edukacyjnych korzystają z Learn Catalog API, aby pobierać informacje o katalogu i wdrażać je w doświadczeniach edukacyjnych 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 jest bezpłatne.

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 się przynajmniej raz dziennie.
• Aktualizacje wersji interfejsu API będą przekazywane za pośrednictwem aktualizacji informacji o wydaniach interfejsu API dla usługi Learn.

Dalsze kroki

Aby dowiedzieć się więcej na temat interfejsu API katalogu Learn, zapoznaj się z następującymi artykułami:

• Rozpocznij pracę z interfejsem API katalogu Microsoft Learn, korzystając z cURL i Visual Studio
• Często zadawane pytania dotyczące interfejsu API katalogu