使用英语阅读

通过


Microsoft Learn 目录 API 功能概述

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

它返回有关所有公开可用项的信息:

  • 模块
  • 单元
  • 学习路径
  • 应用的技能
  • 认证
  • 考试
  • 讲师引导式课程

备注

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

用例

  • 查看有关 Microsoft Learn 培训和/或认证产品/服务的元数据
  • 拉取 Microsoft Learn 培训和/或认证产品/服务的列表,以便从你自己的在线体验链接到它们

Learn 目录 API 的工作原理

该 API 是基于 REST 的 Web API,返回 JSON 编码的响应。 若要请求完整目录,请将 GET 请求发送到:

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

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

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

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

如果有兴趣使用它,请查看通过 cURL 和 Visual Studio Code 开始使用 Microsoft Learn 目录 API 一文

要求

无需身份验证即可访问 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,请查看以下文章: