xAPI(体验 API)是一种电子学习数据和规范接口标准,用于在包括在线和离线在内的广泛学习活动的上下文中收集和共享有关学员体验的数据。
请注意:xAPI 集成仅适用于 Enterprise 方案。
目录
语句
通过与 LMS/LXP/LRS 等第三方系统的 xAPI 集成,Udemy Business 发送与学员的进度和课程完成情况相对应的活动。详细了解 Udemy Business 发送的 xAPI 语句。
集成配置
首先在 LMS/LXP 上完成相关配置后,可以从 Udemy Business 的管理用户界面配置 Udemy Business 以将 xAPI 语句发布到支持的 LMS/LXP。以下是要遵循的步骤*
*请注意,第 1 步和第 2 步需要在 LMS/LXP 端完成。
第 1 步:在 LMS/LXP 中将 Udemy Business 注册为 API 应用程序并生成客户端凭据
此步骤在您的 LMS/LXP 中完成。检查 LMS/LXP 中的管理模块以配置 xAPI 集成。您应该可以选择注册客户端应用程序并为 API 应用程序生成客户端 ID 和客户端密码。
生成客户端凭据时,请确保将访问范围设置为 xapi:write。 (注意:如果没有此范围,则从 Udemy Business 发送到 LMS/LXP 的 xAPI 语句将失败。)
与您的 LMS/LXP 管理员讨论以执行此步骤。
第 2 步:从 LMS/LXP 获取 OAuth 令牌端点和 xAPI 语句端点
此步骤在您的 LMS/LXP 中完成。您的 LMS/LXP 实例应该有一个用于 OAuth 令牌端点和 xAPI 语句端点的 URL。
OAuth 令牌端点是 Udemy Business 将调用以通过提供在步骤 1 中生成的客户端 ID 和客户端密码来生成身份验证令牌的内容。然后,Udemy Business 将使用生成的令牌将 xAPI 语句发布到语句端点。
示例:
令牌端点 URL:https://udemy.lms.com/v3/oauth2/access-token
xAPI 语句端点 URL:https://udemy.lms.com/v3/xapi/statements
请注意:确保端点 URL 准确无误。与您的 LMS/LXP 核对以获取适用于您的实例的正确端点 URL。
步骤 3:在 Udemy Business 中配置 xAPI 集成
1. 导航到“管理”→ “设置”→“LMS/LXP 集成”
2. 对于未包括在内的 LMS/LXP 合作伙伴,请选择“其他”,提供 LMS/LXP 集成和名称,然后选择“保存”。
注意:以下设置页面通常用于启用 API 密钥以访问 Udemy Business REST API(课程和报告 API),也用于设置 xAPI。即使您的 LMS/LXP 在下拉列表中列出,也可能不支持为其配置 xAPI 集成。
3. 选择 LMS 后,选择保存,进入下面的屏幕。第一部分为您提供用于访问标准 Udemy Business REST API(课程和报告 API)的 API 密钥。
4. 选择右上角的编辑集成,并将 xAPI 配置切换到打开。下面突出显示的部分对应于 xAPI 配置。提供 OAuth 令牌 URL、客户端 ID、客户端密码和 xAPI 语句 URL。
5. 提供详细信息后,单击“测试凭据”以检查 Udemy Business 实例是否能够访问令牌 URL。单击“保存”以成功存储您的配置。注意:此测试仅验证 Udemy Business 是否能够成功访问令牌端点。
6. 现在您的 xAPI 与 LMS/LXP 的集成已设置好并可以使用了。
7. 学习者的进度和完成情况现在应该近乎实时地自动流入 LMS/LXP。
配置 - 特殊情况
仅在下列情况下,才应遵循上述步骤:您的 LMS/LXP
- 支持已进行和已完成的事件并
- 接受 mbox(电子邮件)作为参与者的标识符。
如果在 Udemy Business 管理页面上针对您选择的 LMS 显示 xAPI 配置,则任何自定义更改(例如:您的 LMS/LXP 仅支持完成事件或需要不同于 mbox 电子邮件的参与者标识符)都将由 Udemy Business 实施处理。但是,如果您的 LMS 显示在列表中但没有 xAPI 配置部分,或者如果您的自定义 LMS 不在此列表中并且对参与者标识符和/或动词有特殊要求,请联系 Udemy Business 支持部门以提供那些要求。
xAPI 的好处
Udemy Business 已经支持 REST API(用户活动、用户课程活动和用户进度 API)用于报告目的。这些 API 包括细粒度的事务数据(在讲座级别)和聚合的摘要数据(在课程级别)。由于这些不同的聚合级别,这些 API 的延迟时间可能在 8 到 14 小时之间,新数据才能可用。但是,xAPI 语句几乎是实时的,延迟最短,但它们提供的信息较少。
下表总结了标准报告 REST API 和 xAPI 事件流之间的主要区别。
条件 |
xAPI |
报告 REST API |
延迟 |
提供完成事件的近实时发布。低延迟。 |
在完成事件可用之前涉及约 8 小时的延迟。 |
标准 |
遵循行业标准来捕获和报告学员在学习环境中的体验。 |
不遵循标准数据模型,因此可能需要自定义才能将数据移植到不同的系统。 |
互操作性 |
标准数据模型可帮助系统轻松地相互交互并从多个位置构建学员体验的 360 度视图。 |
多个系统之间的交互将需要参与系统之间的数据转换和映射。 |
资源消耗 |
Udemy Business 会将事件推送到第三方系统,因此这些系统不必从 Udemy Business 拉取数据。这样可减少资源消耗和可扩展性问题。 |
需要第三方系统从 Udemy 拉取数据。当请求和有效负载增加时,可能会导致超时问题。 |
面向未来 |
快速发展的行业标准。允许我们扩展到广泛的学员体验事件(未来),例如,跟踪内容、交互、搜索、评论等中的细粒度进度。 |
目前仅限于讲座和课程级别的完成、进度事件,但可以扩展。然而,这可能需要相对更多的工作,因为没有适当的标准。 |