Часто задаваемые вопросы об API каталога Microsoft Learn
В этой статье приводятся часто задаваемые вопросы об API каталога Microsoft Learn с их ответами и ссылками на дополнительные сведения по мере необходимости.
Общие
Вопрос. Сколько стоит использовать API каталога Learn?
Нет затрат на использование API каталога Learn. Дополнительные сведения см. в разделе "Доступность и цены" в обзоре функции API каталога Learn.
Вопрос. Каковы правила использования API каталога Learn?
Ознакомьтесь с условиями использования Microsoft Learn и Microsoft API.
Вопрос. Необходимо ли подключить или получить ключи для использования API каталога Learn?
№ API является общедоступным. См. статью "Начало работы с API каталога Learn" с помощью cURL и Visual Studio Code и /или статьи по справочнику разработчика ПО API для каталога Learn.
Вопрос. Позволяет ли этот API нашим пользователям использовать содержимое Learn, размещенное на нашей платформе?
№ API каталога Learn предоставляет метаданные о содержимом и прямые ссылки на содержимое. Пользователи могут интегрировать эти ссылки в любую Обучение систему управления (LMS) или веб-интерфейс в соответствии с условиями использования API Майкрософт.
Вопрос. Остаются ли данные, возвращаемые API каталога Learn, статическими или изменяемыми?
Данные изменяются всякий раз, когда новое содержимое добавляется, изменяется или удаляется, что обычно выполняется ежедневно.
Ответ API
Вопрос. Можно ли одновременно захватить все данные?
Да. Используйте базовую конечную точку, learn.microsoft.com/api/catalog, чтобы получить полный ответ. Дополнительные сведения о запросе API см. в справочной статье разработчика по API Learn.
Вопрос. Можно ли предварительно отфильтровать ответ?
Да. См. фильтры запросов, доступные в справочной статье по API для разработчиков каталога Learn.
Вопрос. Уникальны ли пользовательские идентификаторы для каждого объекта содержимого?
Да. UID обозначает "Уникальный идентификатор" и является уникальным для каждого объекта содержимого. Если идентификатор пользовательского интерфейса изменяется, даже если заголовок или другие метаданные остаются неизменными, содержимое считается новым объектом.
Вопрос. Почему в сводке модуля отображаются теги HTML?
Как правило, мы стараемся сохранить форматирование сводки в максимально упрощенном виде, но иногда нам необходимо подчеркнуть или связать определенный текст.
Вопрос. Почему нет ссылок на отдельные уроки?
Единицы не записываются как автономное содержимое. Они должны приниматься в определенном порядке для модуля. Поэтому мы даем ссылку на страницу сведений о модуле и первый урок, чтобы пользователи могли начать с этого места и продолжить работу с содержимым.
Вопрос. Как узнать, какое содержимое является новым?
Значение last_modified сообщает вам, когда запись была изменена в последний раз.
Вопрос. Включен ли единый вход для ссылок на содержимое?
В настоящее время нет. Мы стремимся включить единый вход в будущем.
Содержимое
Вопрос. Является ли UID уникальным для содержимого?
Да. UID обозначает "Уникальный идентификатор" и является уникальным для каждого объекта содержимого. Если идентификатор пользовательского интерфейса изменяется, даже если заголовок или другие метаданные остаются неизменными, содержимое считается новым объектом.
Вопрос. Входят ли все модули в какую-либо схему обучения?
№ Модули могут стоять в одиночку, в том смысле, что они учат сценарий или концепцию сквозной в них и не требуют принятия необходимых модулей. Для некоторых это так, и они не являются частью пути обучения. Для других пользователей они объединяются в одну или несколько схем обучения, которые принимают пользователя с помощью создания более сложных концепций. Модуль не должен быть частью схемы обучения или может быть частью одного или нескольких.
Вопрос: Разделы справки знать, когда содержимое было добавлено, обновлено или удалено?
При добавлении новых объектов содержимого в ответе они отображаются как новый объект (определяемый UID). При изменении содержимого можно определить на основе его last_modified значения. При удалении содержимого объект содержимого удаляется из ответа. Хотя в ответе API иногда возникает небольшая задержка при обновлении содержимого, когда пользователь следует URL-адресу содержимого, они всегда видят самые актуальные сведения. При удалении содержимого старый URL-адрес перенаправляется на новое содержимое или интерфейс или на следующий лучший вариант.
В частности, содержимое обновляется все время. Мы публикуем доступные обновления дважды в день. Они могут быть незначительными, например незначительными изменениями текста или основными, такими как основные редакции, дополнения или удаления. В целом портфель содержимого управляется как массивный, высокоуправляемый проект с открытым исходным кодом с тысячами участник, и, как это, изменения происходят все время. Если вы используете API каталога Learn в рабочей системе, вы должны знать об этом и иметь возможность его обрабатывать.
Вопрос. Я последовал за закладками ссылку на содержимое, но теперь показывает мне другой фрагмент содержимого, чем я ожидал. Почему?
Мы стремимся гарантировать, что никто не попадает в тупик (404) со ссылками на наш сайт. При изменении или замене содержимого мы реализуем перенаправление для старой ссылки, которая автоматически приведет вас к новому содержимому. В случае, если содержимое устарело и не заменено по различным причинам, мы перенаправимся на следующий оптимальный подходящий контент, который может быть немного изменен область, или на целевую страницу и т. д.
Вопрос: Разделы справки получить доступ к каталогам примеров документации, видео и кода?
В настоящее время нет программного способа получить доступ к этим каталогам. Мы стремимся обеспечить программный доступ к этим каталогам в будущем.
Локализация
Вопрос. Какие языки доступны в Microsoft Learn?
В Microsoft Learn доступно более 65 языковых стандартов. Полный список можно просмотреть по нижнему колонтитулу сайта (выберите язык, который вы просматриваете, чтобы просмотреть полный список).
Вопрос. Доступно ли содержимое на других языках?
Это зависит от ряда обстоятельств. Мы стремимся сделать содержимое доступным на всех языках, в которых доступны продукты, обучаемые в содержимом. Когда учащиеся посещают сайт Microsoft Learn в заданном языковом стандарте, если содержимое недоступно в этом языковом стандарте, пользователь видит верхний и нижний колонтитул в нужном языковом стандарте, а основное содержимое по умолчанию возвращается на английский, пока локализованная версия не будет доступна.
Вопрос. Отличается ли содержимое для заданного объекта контента в зависимости от того, какой язык вы просматриваете?
Возможно. Когда обновления публикуются на английском языке, наши конвейеры локализации работают для получения локализованных версий обновления как можно скорее — обычно в течение нескольких дней после первоначального изменения.
Другие
Вопрос. Существует ли API отчетов или функциональные возможности для получения данных, таких как представления, щелчки, завершение?
В настоящее время у нас нет API отчетов. У нас есть функциональные возможности создания отчетов организации, позволяющие организациям сообщать о завершении работы пользователей.
Следующие шаги
Дополнительные сведения об API каталога Learn см. по следующим ссылкам: