Microsoft学习目录 API 常见问题解答
本文列出了有关 Microsoft Learn 目录 API 的常见问题,并提供其答案和详细信息的链接。
一般
问:使用 Learn 目录 API 需要花费多少?
使用 Learn 目录 API 无需任何费用。 有关详细信息,请参阅 Learn 目录 API 功能概述文章的可用性和定价部分。
问:使用 Learn 目录 API 的规则是什么?
请参阅 Microsoft Learn 和 Microsoft API 使用条款。
问:是否需要载入或获取密钥才能使用 Learn 目录 API?
不。 API 公开发布。 请参阅使用 cURL 和 Visual Studio Code 的 Learn 目录 API 入门文章,以及/或 Learn 目录 API 开发人员参考文章。
问:此 API 是否会让用户在平台内使用 Learn 内容?
不。 学习目录 API 提供关于内容的元数据和指向内容的直接链接。 用户可以根据 Microsoft API 使用条款将这些链接集成到任何学习管理系统(LMS)或 Web 体验中。
问:从 Learn 目录 API 返回的数据是否保持静态或更改?
每当添加、修改或删除新内容时,数据都会发生更改,这通常是每天。
API 响应
问:是否可以同时获取所有数据?
是的。 使用基础终结点 learn.microsoft.com/api/catalog 获取完整响应。 有关更多 API 请求信息,请参阅 了解目录 API 开发人员参考文章。
问:是否可以预筛选响应?
是的。 请参阅 Learn 目录 API 开发人员参考文章中提供的查询筛选器。
问:每个内容对象的 UID 是否唯一?
是的。 UID 代表“唯一 ID”,并且对于每个内容对象都是唯一的。 如果 UID 发生更改,即使标题或其他元数据保持不变,内容也会被视为新对象。
问:为什么模块摘要中有 HTML 标记?
我们通常尝试尽可能原始地保留摘要的格式,但有时我们需要强调或链接某些文本。
问:为什么没有各个单位的链接?
单元不会编写为独立内容。 它们旨在按模块的特定顺序执行。 因此,我们包括模块详细信息页和第一个单元的链接,以便用户可以从那里开始并继续浏览内容。
问:如何判断哪些内容是新的?
last_modified值指示上次修改记录的时间。
问:是否为内容链接启用了单一 Sign-On(SSO)?
目前不是。 我们的目标是在未来启用 SSO。
内容
问:UID 是否对内容是唯一的?
是的。 UID 代表“唯一 ID”,并且对于每个内容对象都是唯一的。 如果 UID 发生更改,即使标题或其他元数据保持不变,内容也会被视为新对象。
问:所有模块是否都是学习路径的一部分?
不。 模块都能够独立运行,即它们可以完整地教授一个场景或概念,并且不需要学习必备模块。 对于一些人来说,这就是它,它们不是学习路径的一部分。 对于其他用户,它们被捆绑在一个或多个学习路线中,引导用户学习更高级的概念。 模块不必是学习路径的一部分,也可以是一个或多个模块的一部分。
问:如何知道内容何时添加、刷新或删除?
添加新内容对象时,它们会在响应中显示为新对象(由 UID 标识)。 修改内容后,可以通过其最后修改值判断是否有变化。 删除内容后,将从响应中删除内容对象。 尽管 API 响应中更新的内容有时稍有延迟,但当用户关注内容的 URL 时,他们始终会看到最新的信息。 删除内容后,旧 URL 将重定向到新内容或体验,或重定向到下一个最佳选项。
值得注意的是,内容一直都在更新。 我们每天发布两次可用更新。 它们可能是次要的,例如次要文本更改或主要修订,例如主要修订、添加或删除。 一般来说,内容组合作为一个巨大的高度治理的开源项目进行管理,其中包含成千上万的参与者,因此,更改一直发生。 如果在生产系统中使用 Learn 目录 API,则应注意这一点,并让系统能够处理它。
问:我点击了一个书签链接,本想查看某个内容,但现在显示的内容与预期不同。 为什么?
我们努力确保没有人点击到死链接(404),从而导致无法访问我们的网站。 修改或替换内容后,我们将实现旧链接的重定向,该重定向将自动转到新内容。 如果内容已弃用而未因各种原因替换,我们将重定向到下一个最适合的内容,这可能是范围稍作修改的内容,或是一个登陆页面等。
问:如何获取文档、视频和代码示例目录的访问权限?
目前无法以编程方式访问这些目录。 我们的目标是在未来启用对这些目录的编程访问。
地方化
问:Microsoft Learn 中提供了哪些语言?
Microsoft Learn 中提供了超过 65 个区域设置。 可以通过网站页脚在此处查看完整列表(选择要查看的语言以查看完整列表)。
问:内容是否以其他语言提供?
这取决于。 我们的目标是使内容在内容中教授的所有语言中可用。 当学习者访问给定区域设置中的 Microsoft Learn 网站时,如果内容在该区域设置中不可用,则用户在所需区域设置中看到页眉和页脚,核心内容默认返回英语,直到本地化版本可用。
问:给定内容对象的内容是否不同,具体取决于你在其中查看它的语言?
可能。 将更新发布到英语内容时,我们的本地化管道将尽快更新本地化版本 - 通常在原始更改后的几天内完成。
其他
问:是否有任何报告 API 或功能来获取视图、单击、完成等数据?
目前我们没有报告API。 我们确实 组织报告功能,使组织能够报告其用户完成情况。
后续步骤
可以通过访问以下链接了解有关 Learn 目录 API 的详细信息: