Nejčastější dotazy k rozhraní API katalogu Microsoft Learn

Článek
10/05/2023

Tento článek obsahuje nejčastější dotazy k rozhraní API katalogu Microsoft Learn s jejich odpověďmi a odkazy na další informace podle potřeby.

Obecná

Otázka: Kolik stojí použití rozhraní API katalogu Learn?

Používání rozhraní API katalogu Learn není nijak nákladné. Další informace najdete v části Dostupnost a ceny v článku s přehledem funkcí rozhraní API katalogu Learn.

Otázka: Jaká jsou pravidla pro používání rozhraní API katalogu Learn?

Podívejte se na podmínky použití pro Microsoft Learn a rozhraní Microsoft API.

Otázka: Potřebuji připojit nebo získat klíče pro použití rozhraní API katalogu Learn?

Ne. Rozhraní API je veřejně dostupné. Podívejte se na článek Začínáme s rozhraním API pro katalog Learn s využitím cURL a editoru Visual Studio Code nebo článku s referenčními informacemi k rozhraní API služby Learn Catalog.

Otázka: Umožní toto rozhraní API našim uživatelům využívat obsah Learn na naší platformě?

Ne. Rozhraní API katalogu Learn poskytuje metadata o obsahu a přímé odkazy na obsah. Uživatelé mohou tyto odkazy integrovat do libovolného prostředí LMS nebo webového prostředí podle podmínek použití rozhraní MICROSOFT API.

Otázka: Zůstávají data vrácená z rozhraní API katalogu Learn statická nebo se mění?

Data se mění při každém přidání, změně nebo odstranění nového obsahu, který je obvykle každý den.

Odpověď rozhraní API

Otázka: Můžu vzít všechna data najednou?

Ano. Úplnou odpověď získáte pomocí základního koncového bodu learn.microsoft.com/api/catalog. Další informace o žádostech o rozhraní API najdete v článku s referenčními informacemi o rozhraní API služby Learn Catalog.

Otázka: Můžu odpověď předem filtrovat?

Ano. Podívejte se na filtry dotazů, které jsou k dispozici v článku s referenčními informacemi pro vývojáře rozhraní API pro katalog Learn.

Otázka: Jsou identifikátory UID jedinečné pro každý objekt obsahu?

Ano. UID je zkratka "Unique ID" (Jedinečné ID) a je jedinečná pro každý objekt obsahu. Pokud se UID změní, i když název nebo jiná metadata zůstanou stejná, považuje se obsah za nový objekt.

Otázka: Proč jsou v souhrnu modulu značky HTML?

Obvykle se snažíme zachovat formátování souhrnu co nej raw, ale někdy potřebujeme zdůraznit nebo propojit určitý text.

Otázka: Proč neexistují odkazy pro jednotlivé jednotky?

Jednotky nejsou napsané jako samostatný obsah. Mají být převzaty v určitém pořadí pro modul. Z tohoto důvodu zahrneme odkaz na stránku podrobností modulu a první lekci, aby uživatelé mohli začít tam a pokračovat v obsahu.

Otázka: Návody zjistit, jaký obsah je nový?

Hodnota last_modified vám řekne, kdy byl záznam naposledy změněn.

Otázka: Je pro odkazy na obsah povolené jednotné přihlašování (SSO)?

V tuto chvíli to není možné. V budoucnu se snažíme povolit jednotné přihlašování.

Obsah

Otázka: Je UID jedinečný pro obsah?

Otázka: Jsou všechny moduly součástí studijního programu?

Ne. Moduly jsou schopné stát se samostatně, v tom smyslu, že učí scénář nebo koncept v rámci nich a nevyžadují přijetí požadovaných modulů. Pro některé je to a nejsou součástí studijního programu. Pro ostatní jsou seskupené do jednoho nebo více studijních programů, které uživatele provedou vytvářením pokročilejších konceptů. Modul nemusí být součástí studijního programu nebo může být součástí jednoho nebo více modulů.

Otázka: Návody vědět, kdy byl obsah přidán, aktualizován nebo odstraněn?

Když se přidají nové objekty obsahu, zobrazí se v odpovědi jako nový objekt (identifikovaný UID). Při úpravě obsahu můžete zjistit na základě jeho last_modified hodnoty. Když se obsah odstraní, odebere se z odpovědi. I když v odpovědi rozhraní API občas dochází k mírnému zpoždění při aktualizaci obsahu, když uživatel sleduje adresu URL obsahu, vždy uvidí nejaktuálnější informace. Pokud se obsah odstraní, stará adresa URL se přesměruje na nový obsah nebo prostředí.

Obsah se zejména neustále aktualizuje. Aktualizace publikujeme obvykle dvakrát denně. Můžou se jednat buď o menší změny textu, nebo o hlavní změny, jako jsou hlavní revize, doplňky nebo odstranění. Obecně platí, že portfolio obsahu se spravuje jako masivní opensourcový opensourcový projekt s tisíci přispěvatelů a jako takové se neustále mění. Pokud ve svém produkčním systému používáte rozhraní API katalogu Learn, měli byste vědět, jak funguje správa verzí obsahu a jak ho váš systém dokáže zpracovat.

Otázka: Návody získat přístup k dokumentaci, videu a ukázkovým katalogům kódu?

V tuto chvíli neexistuje žádný programový způsob, jak získat přístup k těmto katalogům. V budoucnu se snažíme umožnit programový přístup k těmto katalogům.

Lokalizace

Otázka: Jaké jazyky jsou k dispozici v Microsoft Learn?

V Microsoft Learn je k dispozici více než 65 národních prostředí. Úplný seznam najdete tady prostřednictvím zápatí webu (vyberte jazyk, který si prohlížíte, abyste zobrazili úplný seznam).

Otázka: Je obsah dostupný v jiných jazycích?

To záleží na okolnostech. Snažíme se zpřístupnit obsah ve všech jazycích, ve které jsou produkty, které se učí v obsahu, k dispozici. Když studenti navštíví web Microsoft Learn v daném národním prostředí, pokud obsah není v tomto národním prostředí dostupný, zobrazí se mu záhlaví a zápatí v požadovaném národním prostředí a základní obsah se vrátí zpět do angličtiny, dokud nebude k dispozici lokalizovaná verze.

Otázka: Liší se obsah daného objektu obsahu v závislosti na tom, v jakém jazyce ho zobrazujete?

Možná. Když jsou aktualizace publikovány v anglickém obsahu, naše lokalizační kanály fungují tak, aby se lokalizované verze co nejdříve aktualizovaly – obvykle do několika dnů od původní změny.

Jiné

Otázka: Existuje nějaké rozhraní API pro vytváření sestav nebo funkce pro získání dat, jako jsou zobrazení, kliknutí, dokončení?

V tuto chvíli nemáme rozhraní API pro vytváření sestav. Máme funkce vytváření sestav organizace, které organizacím umožňují hlásit se na dokončení jejich uživatelů.

Další kroky

Další informace o rozhraní API katalogu Learn najdete na následujících odkazech: