通过

Microsoft Learn 目录 API 功能概述

  • 项目

Microsoft Learn 目录 API 是一种基于 REST 的 Web API，可用于发送基于 Web 的查询，Microsoft Learn 并获取有关可用培训内容和认证考试的详细信息，例如标题、产品涵盖、级别、培训链接和其他元数据，并返回包含信息的 JSON 编码响应。

此功能提供有关所有公开资源的信息。

  • 模块
  • 单位
  • 学习路径
  • 应用技能
  • 认证
  • 考试
  • Instructor-Led 课程

注意

作为最近Microsoft Learn 站点更新的一部分，learn.microsoft.com 域中提供了新的目录 API 终结点。 旧终结点仍按预期工作，但切换到新终结点的好处是，它将为你提供增强的功能，例如其他查询参数。

用例

  • 查看有关Microsoft学习培训和/或认证产品的元数据
  • 获取 Microsoft Learn 的培训和/或认证资源列表，以便从您自己的网站链接到这些资源。

学习目录 API 的工作原理

API 是基于 REST 的 Web API，返回 JSON 编码的响应。 若要请求完整目录，请向以下项发送 GET 请求：

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

输出将类似于下面的屏幕截图。 截至 2022 年 11 月，完整响应约为 13 MB。

Visual Studio Code 中 Learn 目录 API 输出的屏幕截图。

每个学习目录项都是一个对象，每个项都有一组可用的元数据。 完整数据字典和其他选项列在 Microsoft Learn 目录 API 开发人员文档。 我们还提供发行说明（链接），以查看最新更新内容，以及最佳实践 信息。

如果有兴趣使用它，请查看 Microsoft Learn 目录 API 入门cURL 和 Visual Studio Code 一文。

要求

无需身份验证即可访问 Microsoft Learn 目录 API。 用户可以使用其首选的 API 请求方法，例如 cURL、Postman 等。

例子

以下是我们观察到用户使用 Learn 目录 API 的几种方式：

  • Viva Learning 使用了 Learn 目录 API，将 Microsoft Learn 目录作为其核心体验的一部分进行提供。
  • 组织和教育机构使用 Learn 目录 API 拉取目录信息并将其发布到其内部学习管理系统 （LMS），以便其员工和学生可以轻松访问它。
  • 学习提供程序使用 Learn 目录 API 拉取目录信息并将其发布到其客户体验中。

可用性和定价

Microsoft Learn 目录 API 是公开可用的，并根据 Microsoft API 使用条款提供。 使用 API 不收取任何费用。

局限性

  • API 包含公开提供的模块、单元、学习路径、讲师主导的课程、考试和认证。 它目前不会输出文档、代码示例、显示或事件。
  • API 每天至少刷新一次。
  • API 版本的更新将通过 Learn 目录 API 发行说明的更新进行通知。

后续步骤

若要了解有关 Learn 目录 API 的详细信息，请查看以下文章：