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

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é

Q: Kolik stojí používání 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 Learn Catalog.

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

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

Q: Potřebuji se registrovat 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 katalogu Learn pomocí knihovny cURL a editoru Visual Studio Code nebo článku Reference k rozhraní API pro katalog Learn.

Q: 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 systému LMS (Learning Management System) nebo webového prostředí podle podmínek použití rozhraní Microsoft API.

Q: 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

Q: 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 "Referenční informace pro vývojáře rozhraní API Learn Catalog".

Q: Můžu odpověď předem filtrovat?

Ano. Podívejte se na filtry dotazů dostupné v článku Developer Reference rozhraní API pro kurz Learn Catalog.

Q: 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.

Q: 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.

Q: Proč neexistují odkazy pro jednotlivé jednotky?

Jednotky nejsou napsané jako samostatný obsah. Mají být plněny v určitém pořadí pro tento 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.

Q: Jak zjistím, jaký obsah je nový?

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

Q: Je pro odkazy na obsah povolené jednotné Sign-On přihlašování (SSO)?

V tuto chvíli ne. Naším cílem je v budoucnu umožnit jednotné přihlašování.

Obsah

Q: Je UID jedinečný pro obsah?

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.

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

Ne. Moduly jsou schopny fungovat samostatně, v tom smyslu, že vyučují scénáře nebo koncepty od začátku do konce a nevyžadují absolvování předchozí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ů.

Q: Jak poznám, kdy byl obsah přidán, aktualizován nebo odstraněn?

Při přidání nových objektů obsahu se v odpovědi zobrazí jako nový objekt (identifikovaný UID). Když je obsah upraven, můžete to zjistit podle hodnoty last_modified. Po odstranění obsahu se objekt obsahu z odpovědi odebere. 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. Při odstranění obsahu se stará adresa URL přesměruje na nový obsah nebo prostředí nebo na další nejlepší možnost.

Obsah se zejména neustále aktualizuje. Dostupné aktualizace publikujeme 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ý projekt s tisíci přispěvateli a proto dochází k neustálým změnám. Pokud ve svém produkčním systému používáte rozhraní API katalogu Learn, měli byste o tom vědět a mít systém schopný ho zpracovat.

Otázka: Sledoval(a) jsem záložkovaný odkaz na obsah, ale teď ukazuje jiný obsah, než jsem čekal. Proč?

Snažíme se zajistit, aby nikdo nenarazil na slepou uličku (chybu 404) kvůli odkazům na naše stránky. Když dojde k úpravě nebo nahrazení obsahu, implementujeme přesměrování starého odkazu, které vás automaticky převedou na nový obsah. V případě, že je obsah zastaralý a není nahrazen z různých důvodů, přesměrujeme na další nejvhodnější obsah, který může být mírně změněný rozsah nebo na cílovou stránku atd.

Q: Jak získám 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

Q: 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).

Q: Je obsah dostupný v jiných jazycích?

Záleží na tom. 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ý, uživatel uvidí záhlaví a zápatí v požadovaném národním prostředí a základní obsah se ve výchozím nastavení vrátí do angličtiny, dokud nebude k dispozici lokalizovaná verze.

Q: 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ý

Q: Existuje nějaké rozhraní API pro reportování nebo funkce pro získání dat, jako jsou zobrazení, kliknutí, dokončení?

V tuto chvíli nemáme rozhraní API pro reportování. Máme organizační funkci vytváření sestav, která organizacím umožňuje podávat zprávy o dokončení jejich uživatelů.

Další kroky

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

• přehled funkcí rozhraní API katalogu Microsoft Learn
• Začínáme s rozhraním API katalogu Microsoft Learn