应用程序开发人员手册

概述 overview

Adobe Learning Manager 是一款基于云端、以学习者为中心的自助式学习管理解决方案。客户可以使用 Adobe Learning Manager API 以编程方式访问 Adobe Learning Manager 资源，以将之与其他企业应用程序集成。Adobe 合作伙伴也可以使用 API，扩展 Adobe Learning Manager 的功能或将之与其他应用程序或服务进行集成，从而提高其价值。

使用场景 usagescenario

开发人员使用 Adobe Learning Manager API 可以构建独立的应用程序，从而扩展 Adobe Learning Manager 的功能，或者可将 Adobe Learning Manager 与其他企业应用程序工作流程进行集成。您可以使用您选择的任何技术来开发 Web 应用程序、桌面客户端或移动应用程序。 作为开发人员，您可以从Learning Manager中访问应用程序数据。 您开发的应用程序部署在Learning Manager平台之外，您可以完全控制应用程序的开发生命周期。 通常应用程序由客户公司进行开发，以便与其 Adobe Learning Manager 帐户结合使用，因此对于特定客户公司来说是隐私应用程序。此外，Adobe 合作伙伴可以使用 Adobe Learning Manager API 构建通用应用程序，这些应用程序可供大量 Adobe Learning Manager 客户使用。

Adobe Learning Manager API apidescription

Adobe Learning Manager API 基于 REST 原则，并通过 HTTP 将 Adobe Learning Manager 对象模型的关键要素显示给应用程序开发人员。开发人员在了解 API 端点的详细信息和 HTTP 方法前，可以先熟悉各种 Adobe Learning Manager 对象、其属性和内部关系。深入了解模型之后，大致了解 API 请求和响应的结构，以及 API 之间通用的一些常用编程术语也同样很有帮助。

有关各种API端点及方法的详细信息，请参阅Learning Manager API文档。

学习者API

Adobe Learning Manager — 学习者API允许您为用户创建自定义学习体验。 使用这些API需要有效的用户令牌，并且仅用于拥有完全许可/注册学习者的工作流程。

未登录的用例需要特殊处理。

如果您对正确使用这些API有任何疑问，请与解决方案体系结构团队联系，确保在部署解决方案之前，解决方案设计师已经审核过该解决方案。

API 身份验证 apiauthentication

在编写向 Adobe Learning Manager 调用 API 的应用程序时，您必须使用集成管理应用程序进行注册。

Adobe Learning Manager API 使用 OAuth 2.0 框架对客户端应用程序进行身份验证和授权。

步骤

1. 设置您的应用程序

您可以使用客户端ID和客户端密钥设置应用程序以使用适当的端点。 注册应用程序后，您可以获取clientId和clientSecret。 应在浏览器中使用 Get URL，因为它会使用预配置的帐户（如 SSO、Adobe ID 等）对 Adobe Learning Manager 用户进行身份验证。

GET https://learningmanager.adobe.com/oauth/o/authorize?client_id=<Enter your clientId>&redirect_uri=<Enter a url to redirect to>&state=<Any String data>&scope=<one or more comma separated scopes>&response_type=CODE.

身份验证成功后，浏览器将重定向到上述 URL 中提到的 redirect_uri。 参数​ 代码 ​随重定向 URI 一起追加。

2. 通过代码获取刷新令牌

POST https://learningmanager.adobe.com/oauth/token Content-Type: application/x-www-form-urlencoded

发布请求正文：

client_id:
<enter your clientid>
 &
 client_secret:
 <enter your clientsecret>
  &
  code:
  <code from step 1></code>
 </enter>
</enter>

3. 从刷新令牌获取访问令牌

用于获取访问令牌的URL：

POST https://learningmanager.adobe.com/oauth/token/refresh Content-Type: application/x-www-form-urlencoded

发布请求正文：

client_id:
<enter your clientid>
 &
 client_secret:
 <enter your clientsecret>
  &
  refresh_token:
  <refresh token>

  </refresh>
 </enter>
</enter>

用于验证访问令牌详细信息的 URL

GET https://learningmanager.adobe.com/oauth/token/check?access_token=<access_token>

使用限制

访问令牌的有效期为七天。 一天后，您必须使用刷新令牌生成新的访问令牌。 如果在现有访问令牌仍然有效的情况下用刷新令牌生成了新的访问令牌，则现有令牌将失效。

下面将介绍 Adobe Learning Manager API 中的一些常用术语，供您参考。

“Includes”

开发人员可以访问单个 API 对象模型，也可以访问与该模型关联的多个模型。 如需访问后续相关模型，您需要了解每个模型与其他模型之间的关系。 Includes ​参数使开发人员能够访问依赖模型。 可以使用逗号分隔符访问多个模型。 有关​ 包含 ​的示例用法以及更多详细信息，请参阅此页面中的示例API模型部分。

API 请求

可以通过发出 HTTP 请求来实现 API 请求。 开发人员可以根据端点和方法的不同，选择不同的 HTTP 动词，如 GET、PUT、POST、DELETE、PATCH 等。 对于某些请求，可以传递查询参数。 在请求特定数据模型时，用户还可以按 JSON API 规范中所述请求相关模型。 示例模型用法中介绍了典型 API 请求的结构。

API 响应

当客户端发出 API 请求时，将根据 JSON API 规范获取 SON 文档。 响应还包含HTTP状态代码，开发人员可以验证该代码，以便在其应用程序逻辑中执行相应的后续步骤。 典型API响应的结构在示例模型用法中描述。

错误

当 API 请求失败时，会得到错误响应。 响应中返回的 HTTP 状态码表示错误的性质。 错误代码以 API 引用中每个模型的数字显示。 200、204、400和404是API中表示的一些常见错误，表示HTTP访问问题。

字段

API 对象的属性及其关系统称为“字段”。 有关更多信息，请参阅 JSON API。在进行API调用以从模型中获取一个或多个特定属性时，您可以使用字段作为参数。 如果没有“字段”参数，API 调用将从模型中获取所有可用属性。 例如，在以下API调用中，字段[skill]=name仅获取技能模型的名称属性。

https://learningmanager.adobe.com/primeapi/v2/users/{userId}/userSkills/{id}?include=skillLevel.skill&fields[skill]=name

分页

有时，API 请求会导致在响应中返回一长串对象。 在这种情况下，分页属性使开发人员能够按多个页面依次获取结果，其中每个页面包含一系列记录。 例如，Adobe Learning Manager 中的分页属性可以让您设置页面中显示的最大记录数。此外，您还可以定义要在页面上显示的记录的范围值。

排序

API 模型中允许排序。 根据模型，选择要对结果应用的排序类型。 可以按升序或降序应用排序。 例如，如果指定code sort=name，则按名称升序排序。 如果指定code sort=-name，则按名称降序排序。 有关详细信息，请参阅JSON API规范。

API 使用说明 samplemodel

如果开发人员希望获取技能名称、技能级别分配的最高点数以及学习者在该技能中获得的点数，我们来考虑一个情景。

Adobe Learning Manager API 中 userSkill 模型由 id、type、dateAchieved、dateCreated、pointsEarned 等默认属性组成。因此，当开发人员使用 GET 方法获取 userSkill 模型的详细信息时，当前与默认属性相关的数据会显示在响应输出中。

但是，在这种情况下，开发人员希望获得用户的技能名称和技能级别的分数。 Adobe Learning Manager API 可以让您使用关系字段和“include”参数来访问这些相关信息。userSkill 的关联模型可在“关系”标签中获取。 您可以通过调用这些模型以及 userSkill 来获取每个关联模型的详细信息。 要获取此信息，请为每个关联的模型使用带有点（句点）分隔值的​ code include ​参数。 您可以使用逗号作为分隔符来请求其他模型，例如user include=skillLevel.skill，course

API 调用

https://learningmanagerqe1.adobe.com/primeapi/v1/users/%7buserId%7d/userSkills/%7bid%7d?include=skillLevel.skill&fields%5bskill%5d=name&fields%5bskillLevel%5d=maxCredits&fields%5buserSkill%5d=pointsEarned

例如，userId 可以是 746783，userSkills id 为 746783_4426_1。

API 调用的响应

\{
 "links": {"self": "https://learningmanager.adobe.com/primeapi/v2/users/746783/userSkills/746783_4426_1?include=skillLevel.skill&fields[userSkill]=pointsEarned&fields[skillLevel]=maxCredits&fields[skill]=name"},
 "data": {
 "id": "746783_4426_1",
 "type": "userSkill",
 "attributes": {"pointsEarned": 5},
 "links": {"self": "https://learningmanager.adobe.com/primeapi/v2/users/746783/userSkills/746783_4426_1"}
 },
 "included": [
 {
 "id": "4426",
 "type": "skill",
 "attributes": {"name": "Java"},
 "links": {"self": "https://learningmanager.adobe.com/primeapi/v2/skills/4426"}
 },
 {
 "id": "4426_1",
 "type": "skillLevel",
 "attributes": {"maxCredits": 10}
 }
 ]
}

Adobe Learning Manager 模型 models

Adobe Learning Manager API 允许开发人员以 RESTful 资源的形式访问 Adobe Learning Manager 对象。 每个 API 端点都表示一个资源，通常为一个徽章之类的对象实例，或此类对象的集合。随后，开发人员可以使用 HTTP 动词，例如 PUT、GET、POST 和 DELETE 在这些对象（集合）上执行 CRUD 操作。

对象属性和关系的列表。

应用程序开发过程 registration

先决条件 prerequisites

作为开发人员，您必须在 Adobe Learning Manager 上创建试用帐户，以便拥有该帐户中所有角色的访问权限。若要编写应用程序，开发人员还需要创建一些用户帐户和课程，并为帐户设置合理的状态，以确保正在开发的应用程序能够访问部分示例数据。

创建客户端 ID 和密钥 createclientidandsecret

应用程序开发和测试 applicationdevelopmentandtesting

开发人员可以使用 Adobe Learning Manager API 构建任何应用程序。开发人员必须确保其帐户由一些有效用户和课程组成。 他们可以创建一些虚拟用户和课程，并在试用帐户中模拟相关活动，以便测试应用程序的功能。

应用程序部署 applicationdeployment

我们建议生产帐户的 Adobe Learning Manager 管理员或集成管理员负责将应用程序提供给其企业内用户。在应用程序经过测试并被认为可以用于生产后，请将该生产帐户告知管理员。 理想情况下，管理员希望在生产帐户中为应用程序生成新的客户端 ID 和客户端密钥，并执行必要的步骤，以安全方式将它们纳入应用程序中。 部署应用程序的实际过程因企业而异，您所在企业的 Adobe Learning Manager 管理员必须获得企业内 IT/IS 部门的支持才能完成部署。

外部应用程序审批 externalapplicationapproval

您可以通过单击​ 应用程序 ​页面右上角的​ 批准 ​来添加外部应用程序。 提供外部应用程序 ID，然后单击​ “保存”。

添加并批准外部应用程序

常见问题解答