Najvhodnejšie postupy na používanie rozhrania API pre Microsoft Learn Catalog
Tento článok popisuje najvhodnejšie postupy pri používaní rozhrania API pre Learn Catalog.
Vysvetlenie podmienok poskytovania služby
Hoci je rozhranie API pre Learn Catalog verejne dostupné a bezplatné na používanie, na používateľov sa vzťahujú podmienky používania rozhrania API od spoločnosti Microsoft. Pred použitím rozhrania API pre Learn Catalog a pred zahrnutím výstupu do produkčného prostredia si prečítajte a porozumejte podmienkam používania rozhrania API.
Vysvetlenie obmedzení rozhrania API pre Learn Catalog
Pozrite si časť Obmedzenia v článku Prehľad funkcií rozhrania API pre Learn Catalog.
Porozumenie con režim stanu l služby Learn
Ak chcete efektívne používať odpoveď rozhrania API pre Learn Catalog, je dôležité rozumieť typom obsahu, ktorý je v službe Microsoft Learn k dispozícii, a navzájom vzťahy. Ďalšie informácie nájdete v článku Learn con režim stanu l.
Najmä:
- UID je skratka pre jedinečné ID a je jedinečná pre každý objekt obsahu. Ak sa identifikátor UID zmení, aj keď názov alebo iné metaúdaje zostanú rovnaké, obsah sa považuje za nový objekt.
- Moduly sú základným objektom v rámci katalógu školení Learn. Všetci sú schopní stáť osamotený v tom zmysle, že v nich učia scenár alebo koncept od konca a nevyžadujú prijatie predpokladových modulov. V niektorých je to všetko a nie sú súčasťou študijného programu. Pre ostatné sú zoskupené v jednom alebo viacerých študijných programe, ktoré sa používateľovi prislúchajú vytvorením pokročilejších konceptov. Modul nemusí byť súčasťou študijného programu alebo môže byť súčasťou jedného alebo viacerých častí.
- Jednotky nie sú napísané ako samostatný obsah. Ich použitie je určené v konkrétnom poradí pre modul. Z tohto dôvodu zahrnieme prepojenie na stránku s podrobnosťami modulu a prvú lekciu, aby tam používatelia mohli začať a pokračovať v obsahu.
Informácie o tom, ako lokalizácia funguje v službe Learn a ako sa lokalizovaný obsah odráža vo výstupe rozhrania API
Microsoft Learn podporuje na lokalite viac ako 65 miestnych nastavení a veľká časť obsahu sa prekladá do týchto miestnych nastavení. Cieľom je sprístupniť obsah vo všetkých jazykoch, v ktorých sú k dispozícii produkty sa učia v obsahu, no nie vo všetkých prostrediach miestneho nastavenia je k dispozícii lokalizovaný obsah.
Ak záznam miestneho nastavenia nemá k dispozícii priradený preklad, obsah na lokalite a odpoveď rozhrania API sa ako predvolená možnosť vráti späť do angličtiny. Vo výstupe rozhrania API uvidíte anglické metaúdaje v iných odpovediach miestneho nastavenia, keď sa vráti. URL adresa obsahu však stále odkazuje na miestne nastavenie, aj keď sa hlavný obsah môže vrátiť späť a dôvodom je umožniť používateľovi naďalej prechádzať na lokalite v danom miestnom nastavení (čo zobrazuje preloženú hlavičku/pätu a akékoľvek iné prepojenie, ktoré má k dispozícii preklad).
Keď sú aktualizácie publikované v anglickom obsahu, naše lokalizované kanály fungujú, aby sa lokalizované verzie aktualizovali čo najskôr – zvyčajne v priebehu niekoľkých dní od pôvodnej zmeny.
Úplný zoznam podporovaných miestnych nastavení môžete zobraziť v päte lokality Microsoft Learn (vyberte jazyk, ktorý si prezeráte). Každé z týchto miestnych nastavení je možné pomocou filtra dotazovať pomocou locale rozhrania API pre Learn Catalog.
Naše záznamy o dokončovaní obsahu školenia sú miestne agnostické, čo znamená, že lokalizované verzie obsahu sa nerozlišujú ako samostatné objekty v záznamoch dokončenia školenia používateľov. Bez ohľadu na jazyk, v akom jazyku používateľ absolvuje školenie, získa kredit za celý objekt a my neukladáme odkaz na jazyk, vom jazyku, v ktorý bol dokončený. Toto dokončenie s miestnym nastavením znamená, že ak implementujete rozhranie API pre Learn Catalog vo svojom vzdelávacom prostredí, musíte to vziať do úvahy a ak načítate objekty obsahu ako samostatné objekty, implementujte medzi nimi ekvivalenciu, aby bez ohľadu na jazyk, v ktorom používateľ absolvuje školenie, získa zaň kredit v iných jazykoch a nemusel sa ho znova zúčastniť.
Zistite, ako funguje tvorba verzií obsahu v službe Learn a ako sa odráža vo výstupe rozhrania API
Predovšetkým sa obsah priebežne aktualizuje. Dostupné aktualizácie publikujete dvakrát denne. Môžu byť menšie, ako napríklad drobné textové zmeny alebo hlavné, ako napríklad hlavné revízie, pridania alebo odstránenia. Vo všeobecnosti sa portfólio obsahu spravuje ako masívny, vysoko riadený open-source projekt s tisíckami prispievateľov, a preto sa zmeny vykonávajú neustále. Ak používate rozhranie API pre Katalóg Learn v produkčnom systéme, mali by ste sa o tom oboznámiť a váš systém ho bude môcť spracovať.
Pri pridaní nových objektov obsahu sa zobrazia ako nový objekt (identifikovaný identifikátorom UID) v odpovedi. Po úprave obsahu môžete určiť na základe jeho last_modified hodnoty. Po odstránení obsahu sa objekt obsahu odstráni z odpovede. Hoci v odpovedi rozhrania API dochádza k miernemu oneskoreniu pri aktualizácii obsahu, keď používateľ sleduje URL adresu obsahu, vždy sa mu zobrazia najaktuálnejšie informácie. V prípade odstránenia sa stará URL adresa presmeruje na nový obsah alebo prostredie alebo na nasledujúcu najlepšiu možnosť.
Momentálne nie sú k dispozícii žiadne odkazy na verzie obsahu po danom dátume last_modified .
Pravidelné obnovenie údajov
Ak používate informácie o katalógu z rozhrania API pre Learn Catalog na podporu vašich obchodných procesov alebo zobrazenie pre zákazníkov v rámci vašej lokality, nezabudnite obnoviť obsah aspoň raz za deň.
Predovšetkým sa obsah priebežne aktualizuje. Dostupné aktualizácie publikujete dvakrát denne. Môžu byť menšie, ako napríklad drobné textové zmeny alebo hlavné, ako napríklad hlavné revízie, pridania alebo odstránenia. Vo všeobecnosti sa portfólio obsahu spravuje ako masívny, vysoko riadený open-source projekt s tisíckami prispievateľov, a preto sa zmeny vykonávajú neustále. Ak používate rozhranie API pre Katalóg Learn v produkčnom systéme, mali by ste sa o tom oboznámiť a váš systém ho bude môcť spracovať.
Kontrola odporúčaní v dokumentácii pre vývojárov
Dokumentácia pre vývojárov k rozhraniu API pre Learn Catalog obsahuje úplný zoznam údajov poskytnutých ako súčasť odpovede a odporúčania o tom, ako sa jednotlivé polia odporúčajú na podporu skvelých vzdelávacích skúseností.
Vysvetlenie logiky dotazu
Existuje mnoho filtrov, ktoré môžete použiť na predbežné filtrovanie odpovede, aby ste získali len to, čo hľadáte, a aby ste mohli zvládnuť menšie veľkosti súborov. Úplný zoznam filtrov dotazov nájdete v článku Referenčné informácie pre vývojárov rozhraní API pre Learn Catalog. Predovšetkým je potrebné dotaz vytvoriť správne a ak v žiadosti používate viac ako jeden parameter dotazu, dotaz sa vyhodnotí pomocou operátora AND.
Ďalšie kroky
Ďalšie informácie na podporu rozhrania API pre Learn Catalog nájdete v nasledujúcich článkoch: