Najčastejšie otázky o rozhraní API pre Microsoft Learn Catalog

Článok
05/16/2024

Tento článok uvádza najčastejšie otázky o rozhraní API pre Microsoft Learn Catalog s ich odpoveďami a prepojeniami na ďalšie informácie podľa potreby.

Všeobecné

Otázka: Koľko stojí používanie rozhrania API learn Catalog?

Nie je potrebné použiť rozhranie API pre Learn Catalog. Ďalšie informácie nájdete v časti Dostupnosť a ceny v článku Prehľad funkcií rozhrania API pre Learn Catalog.

Otázka: Aké sú pravidlá na používanie rozhrania API pre Learn Catalog?

Pozrite si podmienky používania rozhraní Microsoft Learn a Microsoft API.

Otázka: Musím sa pridať do systému alebo získať kľúče, ak chcem používať rozhranie API learn Catalog?

Nie. Rozhranie API je verejne dostupné. Pozrite si článok Začíname s rozhraním API pre Learn Catalog pomocou cURL a Visual Studio Code a/alebo v článku Referenčné informácie pre vývojárov k rozhraniu API pre Learn Catalog.

Otázka: Umožní toto rozhranie API našim používateľom využívať obsah služby Learn v rámci našej platformy?

Nie. Rozhranie API pre Katalóg Learn poskytuje metaúdaje o obsahu a priame prepojenia na obsah. Používatelia môžu integrovať tieto prepojenia do ľubovoľného systému Vzdelávanie Management System (LMS) alebo webového prostredia v súlade s podmienkami používania rozhrania API spoločnosti Microsoft.

Otázka: Zostávajú údaje vrátené z rozhrania API služby Learn Catalog statické alebo sa menia?

Údaje sa menia pri každom pridaní, úprave alebo odstránení nového obsahu, čo zvyčajne prebieha denne.

Odozva rozhrania API

Otázka: Môžem chytiť všetky údaje naraz?

Áno. Ak chcete získať úplnú odpoveď, použite základný koncový bod learn.microsoft.com/api/catalog. Ďalšie informácie o požiadavke rozhrania API nájdete v článku Referenčné informácie o rozhraní API pre Katalóg Learn.

Otázka: Môžem vopred filtrovať odpoveď?

Áno. Pozrite si filtre dotazov, ktoré sú k dispozícii v článku Referenčné informácie pre vývojárov rozhraní API pre Learn Catalog.

Otázka: Sú UID jedinečné pre každý objekt obsahu?

Áno. 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.

Otázka: Prečo sú v súhrne modulu značky HTML?

Zvyčajne sa snažíme, aby bolo formátovanie súhrnu čo najspracnejšie, ale niekedy musíme zdôrazniť alebo prepojiť určitý text.

Otázka: Prečo nie sú prepojenia na jednotlivé jednotky?

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.

Otázka: Ako zistím, ktorý obsah je nový?

Hodnota last_modified vás informuje o tom, kedy bol záznam naposledy upravený.

Otázka: Je jediné prihlásenie (SSO) povolené pre prepojenia na obsah?

Momentálne nie. Cieľom je v budúcnosti povoliť jediné prihlásenie.

Obsah

Otázka: Je identifikátor UID jedinečný pre obsah?

Otázka: Sú všetky moduly súčasťou študijného programu?

Nie. Všetky moduly dokážu stáť samostatne 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í.

Otázka: Ako zistím, kedy bol obsah pridaný, obnovený alebo odstránený?

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 im zobrazia najaktuálnejšie informácie. Po odstránení obsahu sa stará URL adresa presmeruje na nový obsah alebo prostredie alebo na nasledujúcu najlepšiu možnosť.

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ť.

Otázka: Na obsah sme sledovali prepojenie označené záložkou, ale teraz mi zobrazuje iný obsah, ako som očakával. Prečo?

Snažíme sa zabezpečiť, aby nikto hity dead-end (404) s odkazmi na naše stránky. Po úprave alebo nahradení obsahu implementujeme presmerovanie na staré prepojenie, ktoré vás automaticky presmeruje na nový obsah. V prípade, že obsah je zastaraný a nie je nahradený z rôznych dôvodov, presmerujeme sa na ďalší najlepší vhodný obsah, ktorý môže byť mierne upravený rozsah, alebo na stránku prvého kontaktu atď.

Otázka: Ako získam prístup k dokumentácii, videu a vzorovým katalógom kódu?

V súčasnosti neexistuje žiadny programový spôsob na získanie prístupu k týmto katalógom. Cieľom je umožniť programový prístup k týmto katalógom v budúcnosti.

Lokalizácia

Otázka: Aké jazyky sú k dispozícii v službe Microsoft Learn?

V službe Microsoft Learn je k dispozícii viac ako 65 miestnych nastavení. Úplný zoznam môžete vidieť tu prostredníctvom päty lokality (výberom jazyka, ktorý si prezeráte, aby sa zobrazil úplný zoznam).

Otázka: Je obsah k dispozícii v iných jazykoch?

Závisí to od rôznych faktorov. Cieľom je sprístupniť obsah vo všetkých jazykoch, v ktorých sú produkty vyučované v obsahu dostupné. Ak študijní používatelia navštívia lokalitu Microsoft Learn v danom miestnom nastavení, ak obsah nie je k dispozícii v tomto miestnom nastavení, používateľ uvidí hlavičku a pätu vo svojom požadovanom miestnom nastavení a základný obsah sa predvolene nastaví na angličtinu, kým nie je k dispozícii lokalizovaná verzia.

Otázka: Líši sa obsah pre daný objekt obsahu v závislosti od jazyka, v akom ho zobrazujete?

Možno. 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.

Iné

Otázka: Existuje nejaké rozhranie API na vytváranie zostáv alebo funkcie na získavanie údajov, ako sú zobrazenia, kliknutia, dokončenie?

Momentálne nemáme rozhranie API na vytváranie zostáv. Máme k dispozícii funkciu organizational reporting, ktorá umožňuje organizáciám hlásiť dokončenia svojich používateľov.

Ďalšie kroky

Ďalšie informácie o rozhraní API pre Katalóg Learn nájdete na nasledujúcich prepojeniach:

Zdieľať cez