Sdílet prostřednictvím

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 pro Instructor-Led

Poznámka

K dispozici je nová sada koncových bodů rozhraní API pro přístup k datům katalogu Microsoft Learn, která nahrazuje rozhraní API katalogu Learn. Stávající koncový bod zdokumentovaný zde bude fungovat až do června 2026, ale plánuje se jeho vyřazení. Doporučujeme migrovat na nové koncové body v rozhraní API platformy Microsoft Learn , abyste mohli využívat rozšířené funkce, včetně dalších parametrů 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.

snímek obrazovky s výstupem rozhraní API pro katalog Learn v editoru Visual Studio Code

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 uvedeny v dokumentaci pro vývojáře k rozhraní API katalogu Microsoft Learn. Máme také poznámky k verzi (odkaz), abychom zjistili, co jsou nejnovější aktualizace, a osvědčené postupy informace.

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 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 Learning 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.
  • Poskytovatelé učení používají rozhraní API pro katalog Learn k získání informací o katalogu a jejich publikování ve svých zkušenostech se zákaznickým učením.

Dostupnost a ceny

Rozhraní API katalogu Microsoft Learn je veřejně dostupné a nabízeno podle 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 nevytváří dokumentaci, ukázky kódu, představení ani události.
  • Rozhraní API se aktualizuje alespoň jednou denně.
  • Aktualizace verze rozhraní API budou oznámeny prostřednictvím aktualizací v Poznámky k verzi rozhraní API katalogu Learn.

Další kroky

Další informace o rozhraní API katalogu Learn najdete v následujících článcích:

  • Last updated on