Поділитися через

API каталогу Microsoft Learn: запитання й відповіді

  • Стаття

У цій статті наведено поширені запитання про API каталогу Microsoft Learn з їхніми відповідями та посиланнями на додаткові відомості за потреби.

Загальне

Q. Скільки коштує використання API каталогу Learn?

Використовувати API каталогу Learn не потрібно. Докладні відомості див. в розділі Доступність і ціни в статті огляд функцій API Learn Catalog API.

Q. Які правила використання API каталогу Learn?

Перегляньте Microsoft Learn та Умови використання API Microsoft.

Q. Чи потрібно перейти на борт або отримати ключі, щоб використовувати API каталогу Learn?

Ні. Інтерфейс API загальнодоступний. Див. статтю Початок роботи з API каталогу Learn за допомогою статті CURL і Visual Studio Code та/або статті довідника розробника API каталогу learn.

Q. Чи дозволить цей інтерфейс API нашим користувачам використовувати вміст Learn у нашій платформі?

Ні. API каталогу Learn надає метадані про вміст і прямі посилання на вміст. Користувачі можуть інтегрувати ці посилання в будь-яку систему керування навчанням (LMS) або веб-інтерфейс відповідно до Умов використання API Microsoft.

Q. Чи дані, повернуті з API каталогу Learn, залишаються статичними або змінюються?

Дані змінюються щоразу, коли додається, змінюється або видаляється новий вміст, який зазвичай щодня.

Відповідь API

Q: Чи можна одночасно захопити всі дані?

Так. Використовуйте базову кінцеву точку, learn.microsoft.com/api/catalog, щоб отримати повну відповідь. Докладні відомості про запит API див. в статті довідник із розробника API каталогу Learn.

Q. Чи можна попередньо відфільтрувати відповідь?

Так. Перегляньте фільтри запитів, доступні в довідковій статті розробника API API Learn Catalog.

Q. Чи унікальні ідентифікатори інтерфейсу користувача для кожного об'єкта вмісту?

Так. Ідентифікатор UID означає "Унікальний ідентифікатор" і унікальний для кожного об'єкта вмісту. Якщо ідентифікатор UID зміниться, навіть якщо заголовок або інші метадані залишаються незмінними, вміст вважається новим об'єктом.

Q. Чому в зведенні модуля є теги HTML?

Зазвичай ми намагаємося зберегти форматування зведення як необроблене, але іноді потрібно виділити або зв'язати певний текст.

Q. Чому немає посилань для окремих одиниць?

Одиниці не написані як автономний вміст. Вони мають бути прийняті в певному порядку для модуля. З цієї причини ми включаємо посилання на сторінку відомостей про модуль і першу одиницю, щоб користувачі могли почати роботу з ним і продовжити роботу з вмістом.

Q. Як дізнатися, який вміст новий?

Значення last_modified повідомляє, коли востаннє змінено запис.

Q. Чи ввімкнуто єдиний Sign-On (єдиний вхід) для посилань на вміст?

Наразі ні. Ми прагнемо ввімкнути єдиний вхід у майбутньому.

Вміст

Q: чи унікальний ідентифікатор UID для вмісту?

Так. Ідентифікатор UID означає "Унікальний ідентифікатор" і унікальний для кожного об'єкта вмісту. Якщо ідентифікатор UID зміниться, навіть якщо заголовок або інші метадані залишаються незмінними, вміст вважається новим об'єктом.

Q. Чи всі модулі є частиною навчального шляху?

Ні. Модулі здатні стояти окремо в тому сенсі, що вони навчають сценарію або концепції наскрізь і не вимагають прийняття обов'язкових модулів. Для деяких це так, і вони не є частиною навчального шляху. Для інших користувачів вони об'єднуються в один або кілька навчальних шляхів, які допомагають користувачу створювати більш розширені концепції. Модуль не має бути частиною навчального шляху, або він може бути частиною одного або кількох.

Q. Як дізнатися, коли вміст додано, оновлено або видалено?

Коли додаються нові об'єкти вмісту, вони відображаються у відповіді як новий об'єкт (визначений ідентифікатором UID). Коли вміст змінюється, ви можете визначити його last_modified значення. Коли вміст видаляється, об'єкт вмісту видаляється з відповіді. Хоча іноді в відповіді API оновлюється незначна затримка вмісту, коли користувач стежить за URL-адресою вмісту, він завжди бачить найновіші відомості. Коли вміст видаляється, стара URL-адреса переспрямовуватиметься до нового вмісту чи можливості або до наступного найкращого параметра.

Примітно, що весь час оновлюється вміст. Ми публікуємо доступні оновлення двічі на день. Вони можуть бути незначними, наприклад незначними змінами тексту або основними, наприклад основними виправленнями, додаваннями або видаленнями. Загалом, портфелем вмісту керується як масовий, висококонкурсований проект із відкритим кодом із тисячами співавторів, і, як такий, зміни відбуваються весь час. Якщо ви використовуєте API каталогу Learn у своїй виробничій системі, ви маєте знати про це та мати можливість працювати з нею.

Запитання. Я пішов за закладкою посилання на вміст, але тепер показує мені інший фрагмент вмісту, ніж я очікував. Чому?

Ми прагнемо, щоб ніхто не потрапив у глухий кут (404) з посиланнями на наш сайт. Коли вміст змінюється або замінюється, ми впроваджуємо переспрямування старого посилання, яке автоматично перемістить вас до нового вмісту. Якщо вміст вилучено та не замінено з різних причин, ми переспрямуємо до наступного оптимального вмісту, який може бути дещо зміненим або на цільову сторінку тощо.

Q. Як отримати доступ до документації, відео та зразків кодів каталогів?

Наразі немає програмного способу отримати доступ до цих каталогів. Ми прагнемо надати програмний доступ до цих каталогів у майбутньому.

Локалізації

Q. Які мови доступні в Microsoft Learn?

У Microsoft Learn доступно понад 65 мов. Повний список можна переглянути за допомогою нижнього колонтитула сайту (виберіть мову, яка переглядається, щоб переглянути повний список).

Q. Чи доступний вміст іншими мовами?

Це залежить. Ми прагнемо зробити вміст доступним для всіх мов, якими викладаються продукти в вмісті. Коли слухачі відвідують сайт Microsoft Learn у певній мові, якщо вміст недоступний у цій мові, він бачитиме верхній і нижній колонтитул у потрібній мові, а основний вміст за замовчуванням повертається до англійської, доки не буде доступна локалізована версія.

Q. Чи відрізняється вміст для певного об'єкта вмісту залежно від мови, якою ви його переглядаєте?

Пе́вно. Коли оновлення публікуються в англійському вмісті, наші конвеєри локалізації працюють над тим, щоб локалізовані версії оновилися якомога швидше – зазвичай протягом кількох днів після початкової зміни.

Інший

Q. Чи є інтерфейс API або функції звітування для отримання таких даних, як подання, клацання, завершення?

Наразі у нас немає інтерфейсу API звітування. Ми маємо функціональні можливості звітування організації, які дають змогу організаціям звітувати про завершення своїх користувачів.

Наступні кроки

Докладні відомості про API каталогу Learn див. за наведеними нижче посиланнями.