Обзор функций API каталога Microsoft Learn

  • Статья

API каталога Microsoft Learn — это веб-API на основе REST, который позволяет отправлять веб-запрос в Microsoft Learn и получать подробные сведения о доступном обучающем контенте и сертификационных экзаменах, таких как названия, продукты, охватываемые, уровни, ссылки на обучение и другие метаданные и возвращающие ответ в кодировке JSON с информацией.

Он возвращает сведения обо всех следующих общедоступных компонентах:

  • Модули
  • единиц(ы)
  • Схемы обучения
  • Примененные навыки
  • Сертификации
  • Экзамены
  • курсы под руководством инструктора;

Примечание.

В рамках недавнего обновления сайта Microsoft Learn существует новая конечная точка API каталога, доступная в домене learn.microsoft.com. Старая конечная точка по-прежнему будет работать должным образом, но преимущества переключения на новую конечную точку заключаются в том, что она предоставит расширенные функции, такие как дополнительные параметры запроса.

Случаи использования

  • Просмотр метаданных о предложениях по обучению Microsoft Learn и (или) сертификации
  • Вытащите список предложений по обучению Microsoft Learn и (или) сертификации, чтобы связать их с ними из собственного онлайн-интерфейса

Как работает API каталога Learn

API — это веб-API на основе REST, который возвращает ответ в кодировке JSON. Чтобы запросить полный каталог, отправьте запрос GET по адресу:

https://learn.microsoft.com/api/catalog/

Выходные данные будут выглядеть примерно так, как на снимок экрана ниже. По состоянию на ноябрь 2022 года полный ответ составляет примерно 13 МБ.

Screenshot of the Learn Catalog API output in Visual Studio Code.

Каждый элемент каталога обучения — это объект с набором метаданных, доступных для каждого из них. Полный словарь данных и другие параметры перечислены в документации разработчика API каталога Microsoft Learn. У нас также есть заметки о выпуске (ссылка), чтобы узнать, какие последние обновления являются, и сведения о рекомендациях .

Если вы хотите использовать его, проверка из статьи "Начало работы с API каталога Microsoft Learn" с помощью cURL и Visual Studio Code.

Требования

Для доступа к API каталога Microsoft Learn не требуется проверка подлинности. Пользователи могут использовать предпочитаемый метод запроса API, например cURL, Postman и т. д.

Примеры

Ниже приведено несколько способов просмотра пользователей с помощью API каталога Learn:

  • Viva Обучение использовал API каталога Learn для предложения каталога Microsoft Learn в рамках основного интерфейса.
  • Организации и учебные заведения используют API каталога Learn для извлечения сведений о каталоге и публикации их в своих внутренних системах управления обучением (LMS), чтобы их сотрудники и учащиеся могли легко получить к нему доступ.
  • Обучение поставщики используют API каталога Learn для извлечения сведений о каталоге и их публикации в своих интерфейсах обучения клиентов.

Доступность и цены

API каталога Microsoft Learn общедоступен и предоставляется в рамках условий использования API Майкрософт. Плата за использование API не взимается.

Ограничения

  • API содержит общедоступные модули, единицы обучения, пути обучения, курсы под руководством инструктора, экзамены и сертификации. В настоящее время он не выводит документацию, примеры кода, показывает или события.
  • API обновляется по крайней мере один раз в день.
  • Обновления в версию API будут передаваться с помощью обновлений в Заметки о выпуске API каталога.

Следующие шаги

Дополнительные сведения об API каталога Learn см. в следующих статьях: