Adobe Captivate Prime 是一款基于云端,以学习者为中心的自助式学习管理解决方案。Prime API 提供了 Prime 上可用资源的访问权限,并以此提供了编程化的访问方式,以便客户可以扩展 Prime 的功能并将其与用来部署无缝工作流的其他企业应用程序进行集成。API 还可让 Adobe 合作伙伴通过扩展 Prime 的功能或与常用应用程序或服务进行集成来提高其价值。

Prime API 基于 REST 的结构原则,并以资源的形式显示 Prime 对象模型的关键要素(例如用户、课程、学习方案和注册)。所有 API 请求都在特定用户环境下生成,该用户已通过身份认证,可访问特定的 Prime 帐户。因此,用户可以仅访问该帐户内的数据,以及管理用户的角色和权限。

在版本 1 中,Prime API 主要侧重于为大多数资源提供 GET 访问权限。请参阅 API 文档以获取端点和方法的完整列表。Prime 拥有数据非常丰富的模型,包括多种对象类型(资源)以及内部关系,因此我们选择遵循 JSONAPI v1.0 规范,能以多形态方式进行侧载和 API 响应。

开发人员使用 Prime API 可以构建独立的应用程序,从而扩展 Prime 的功能,甚至可将 Prime 与涉及其他企业应用程序的特定工作流环境进行集成。您开发的应用程序通常会部署在 Prime 平台(可以是网页应用程序、桌面应用程序、移动应用程序)之外,并且开发人员拥有完整的控制权限,可以在应用程序生命周期内对其进行管理。通常应用程序由客户公司进行开发,以便与其 Prime 帐户结合使用,因此对于特定客户公司来说是“隐私”应用程序。但是,Adobe 合作伙伴还可以使用 Prime API 来构建常规应用程序,从而供众多 Prime 客户“公共”使用。

下一节简要概述了 Prime API 并且大致介绍了示例应用程序的代码。本文档的其余部分侧重于开发人员如何获取并管理应用程序的密钥,以及应用程序如何获得 Prime 帐户的信赖。有关各种 API 端点和方法的详细信息,请参阅 API 文档。

Prime API

Prime API 基于 REST 的原则,并通过 HTTP 将 Prime 对象模型的关键要素显示给应用程序开发人员。开发人员在了解 API 端点的详细信息和 HTTP 方法前,会发现如果首先熟悉各种 Prime 对象、其属性和内部关系会很有帮助。深入了解模型后,对于了解 API 请求和相应的结构会很有帮助,并且了解 API 之间通常互相支持的部分常用编程习语也同样很有帮助。最后,本节结尾大概介绍了一个简单示例的代码。

Prime 模型

Prime API 允许开发人员以 RESTful 资源的形式访问 Prime 对象。这实质上意味着每个 API 端点都表示了一个资源(通常为一个对象实例,例如徽章;或此类对象的集合)。随后,开发人员可以使用 HTTP 动词,例如 PUT、GET、POST 和 DELETE 在这些对象(集合)上执行 CRUD 操作。

下表列出了 Prime 对象模型的各种元素

应用程序开发过程

开发和测试

获取开发人员帐户

建议开发人员首先在 Prime 上创建试用帐户,以便拥有该帐户中所有角色的访问权限。若要编写应用程序,开发人员还需要创建一些用户帐户和课程,并为帐户设置合理的状态,以便正在开发的应用程序能够访问部分虚拟数据

创建客户端 ID 和密钥

解释了如何切换到集成管理员角色并注册新的应用程序。显示屏幕快照并解释各个字段

进行应用程序开发和测试

开发人员可使用 Prime API 构建任何种类的应用程序。在开发过程中,开发人员需要确保试用帐户中包含一些用户和课程。开发人员最好能够创建一些虚拟用户和虚拟课程,并在试用帐户中模拟相关活动,以便测试应用程序的功能。

本产品经 Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License 许可  Twitter™ 与 Facebook 中的内容不在 Creative Commons 的条款约束之下。

法律声明   |   在线隐私策略