Přehled funkcí rozhraní API katalogu Microsoft Learn
Rozhraní API katalogu Microsoft Learn je webové rozhraní API založené na REST, které umožňuje odeslat webový dotaz do Microsoft Learn a získat zpět podrobnosti o dostupných školicích obsahech a certifikačních zkouškách, jako jsou názvy, produkty, probírané úrovně, odkazy na trénování a další metadata a vrací odpověď zakódovanou ve formátu JSON s informacemi.
Vrátí informace o všech veřejně dostupných informacích:
- Moduly
- Jednotky
- Studijní programy
- Použité dovednosti
- Certifikace
- Zkoušky
- Kurzy řízené instruktorem
Poznámka:
Součástí nedávné aktualizace webu Microsoft Learn je nový koncový bod rozhraní API katalogu dostupný v learn.microsoft.com doméně. Starý koncový bod bude i nadále fungovat podle očekávání, ale výhody přechodu na nový koncový bod představují, že vám poskytne vylepšené funkce, jako jsou další parametry dotazu.
Případy použití
- Zobrazení metadat o školicích a certifikačních nabídkách Microsoft Learn
- Stáhněte si seznam školicích a/nebo certifikačních nabídek Microsoft Learn, abyste je mohli propojit z vlastního online prostředí.
Jak funguje rozhraní API katalogu Learn
Toto rozhraní API je webové rozhraní REST, které vrací odpověď zakódovanou ve formátu JSON. Pokud chcete požádat o úplný katalog, odešlete požadavek GET na:
https://learn.microsoft.com/api/catalog/
Výstup bude vypadat podobně jako na následujícím snímku obrazovky. Od listopadu 2022 je úplná odpověď přibližně 13 MB.
Každá položka katalogu výukových materiálů je objekt s sadou metadat dostupných pro každý z nich. Úplný slovník dat a další možnosti jsou uvedené v dokumentaci pro vývojáře rozhraní API katalogu Microsoft Learn. Máme také poznámky k verzi (odkaz), abychom zjistili, co jsou nejnovější aktualizace, a informace o osvědčených postupech .
Pokud vás zajímá, jak ho používat, podívejte se na článek Začínáme s rozhraním API katalogu Microsoft Learn pomocí cURL a editoru Visual Studio Code.
Požadavky
Pro přístup k rozhraní API katalogu Microsoft Learn není potřeba žádné ověřování. Uživatelé můžou použít upřednostňovanou metodu žádosti o rozhraní API, jako je cURL, Postman atd.
Příklady
Níže je několik z mnoha způsobů, jak vidíme uživatele používající rozhraní API katalogu Learn:
- Viva Učení využívá rozhraní API pro katalog Learn k nabídce katalogu Microsoft Learn jako součást svého základního prostředí.
- Organizace a vzdělávací instituce používají rozhraní API pro katalog Learn k získání informací o katalogu a jejich publikování ve svých interních systémech pro správu učení (LMS), aby k nim mohli snadno přistupovat zaměstnanci a studenti.
- Učení poskytovatelé používají rozhraní API katalogu Learn k získání informací o katalogu a jejich publikování ve svých zkušenostech se zákazníky.
Dostupnost a ceny
Rozhraní API katalogu Microsoft Learn je veřejně dostupné a nabízeno v rámci podmínek použití rozhraní API společnosti Microsoft. Za použití rozhraní API se neúčtují žádné poplatky.
Omezení
- Rozhraní API obsahuje veřejně dostupné moduly, jednotky, studijní programy, kurzy řízené instruktorem, zkoušky a certifikace. V tuto chvíli neprovádí výstupní dokumentaci, ukázky kódu, zobrazení ani události.
- Rozhraní API se aktualizuje alespoň jednou denně.
- Aktualizace k verzi rozhraní API se budou předávat prostřednictvím aktualizací Přečtěte si poznámky k verzi rozhraní API katalogu.
Další kroky
Další informace o rozhraní API katalogu Learn najdete v následujících článcích: