要求

必备知识

  • 了解 AEM Mobile
  • 有关通过点播门户创建和发布内容的知识
  • 使用 On-Demand Services API 的经验

必要的产品

  • AEM Mobile
  • 访问 On-Demand Services API

简介

Adobe Experience Manager Mobile (AEM Mobile) 提供了一个强大的 On-Demand Services API,用于以编程方式管理文章、集合、产品、推送通知等。该 API 还支持与内容管理系统、基于 Web 的创作工具以及发布工作流程系统的第三方集成,上述系统/工具现在多数已经可用。(有关更多详细信息,请参阅将第三方系统与 AEM Mobile 集成。)

无论您想要编写与 On-Demand Services API 接合的自定义代码,还是想要利用现有的与第三方系统的集成,您都需要有效的 API 凭据。本文说明了如何使用 API 密钥。

 

API 凭据

API 凭据包含以下项目:

  • API 密钥和客户端机密是访问 API 网关的凭据。
  • 设备 ID 和设备令牌是识别 API 用户的凭据。

API 使用情况和要求

根据您希望如何通过 On-Demand Services API 连接,会有以下要求。

托管(多租户)解决方案

示例:WoodWing Enterprise、WoodWing Inception、Storied 和 Specle。

  • 每个托管解决方案都需要自己的 API 密钥。
  • 托管解决方案的用户无需自己的 API 密钥。
  • 解决方案所有者为用户/客户提供此 API 密钥。
  • 托管解决方案的用户使用此 API 密钥生成自己的设备 ID 与设备令牌,然后将这些凭据输入托管解决方案中。

预置(单租户)解决方案

示例:Adobe Experience Manager、vjoon K4、WordPress 和 Drupal。

  • 每位要部署预置解决方案的客户都需要自己的 API 密钥。
  • 客户可以在其实现的多个预置解决方案中使用其 API 密钥。
  • 客户需要生成自己的设备 ID 与设备令牌,并将这些凭据输入预置解决方案中。

自定义集成

示例:由合作伙伴或客户编码的自定义工作流程。

  • 和预置(单租户)情形相同的要求。
  • 客户需要自己的 API 密钥、设备 ID 和设备令牌。

请参阅下面各部分以了解有关获取您需要的 API 凭据的信息。

请求 API 密钥

API 密钥用于获取对 Adobe API 网关的访问权限。此网关是也被 API 使用的一个通用基础结构。所有公共 API 都位于 Adobe API 网关后面。要能够与 API 网关后面的服务交互,您需要 API 密钥。API 密钥不绑定到单个 Adobe ID 上,除非 Adobe 撤消它们,否则不会过期。API 密钥由两部分组成,即名称和机密。您可以将机密看作是 API 密钥的“密码”。

API 密钥和客户端机密有时叫做其他名称。以下各项是等同的:

API 密钥 =“IMS 客户端 ID”=“客户端 ID”=“Adobe API 密钥”=“Adobe 密钥”

客户端机密 =“机密”=“Adobe API 机密”=“Adobe 机密”

要请求 API 密钥,请下载并提交请求表 PDF。有关详细信息,请参阅将第三方系统与 AEM Mobile 集成:API 密钥

建议您不要使用主管理员 Adobe ID 进行 API 访问。仅使用主管理员帐户创建项目并向每个必需项目添加专用帐户。例如,如果您有一个 Drupal 实例和一个 WordPress 实例,您的主管理员是 aemm_master@adobe.com,则您的 Drupal 专用API Adobe ID 可以是 aemm_drupal@adobe.com(非主管理员)。您的 WordPress 专用 Adobe ID 可以是 aemm_wordpress@adobe.com(非主管理员)。然后,(例如)您可以使用 aemm_master@adobe.com 创建名为“Drupal Mag”和“WordPress Mag”的项目,并且仅使用必要的角色和权限将 aemm_drupal@adobe.com 和 aemm_wordpress@adobe.com 添加到这些项目。向这些专用 API 帐户仅授予您的预期 API 使用所需的权限,例如“添加和编辑内容”、“删除内容”、“查看内容”和“发布内容”。查看您的解决方案的文档,以了解所需的特定权限。请参阅 AEM Mobile 的帐户管理

如果您请求被准许,则会获得 IMS 客户端 ID(它是您的 API 密钥)和客户端机密。您的指定 Adobe ID 将被列入“白名单”,这样您就可以创建关联的设备 ID 与设备令牌(如下面的几个步骤中所述)。

 

 

 

生成设备 ID 与设备令牌

一旦您有了 API 密钥和客户端机密,您便需要生成设备 ID 和设备令牌,用于识别 API 用户。

  1. https://aex.aemmobile.adobe.com/ 访问 IMS 设备令牌生成器(“AEX 门户”),然后输入您的 API 密钥/IMS 客户端 ID。
  2. 使用列入白名单的、您想要为其创建设备 ID/令牌的 Adobe ID(您在 API 密钥请求单中指定的 Adobe ID)登录。
  3. 将会生成并显示设备 ID 和设备令牌。复制它们并将其保存在一个安全的位置。

请注意,如果 Adobe ID 密码发生更改,设备 ID/令牌设备将会无效。您可以将设备 ID/设备标记看作是 Adobe ID 和密码的哈希值。

另外请注意,设备 ID/设备令牌的有效期为 6 个月,如果不使用,将变得无效。如果使用它,它将自动续新。

访问 AEM Mobile API

如果您通过 API 连接一个支持的第三方系统,您将仅需在系统的设置过程中将 API 密钥和客户端机密(仅用于预置/单租户解决方案)、设备 ID 和设备令牌输入相应字段中。

如果您直接通过自己的自定义代码访问 API,请按照 On-Demand Services API 包中的文档进行操作:

  • 设备 ID/设备令牌用于通过身份验证 API 端点生成访问令牌。
  • API 密钥和访问令牌的组合对于所有 API 调用都是必需的。

在开发和生产中使用 API 密钥

如果您在开发自定义集成,或者如果您有单独的生产和开发预置系统,则应对开发和生产使用单独的 API 密钥。

当您开发一个新系统时,您可以使用上述操作步骤请求 API 密钥。一旦您开始将系统部署到生产,便需要再请求一个 API 密钥。

逐步取消设备 ID 和设备令牌技术帐户

未来,设备 ID 和设备令牌工作流程将由通过点播门户管理的新技术帐户实现替代。API 密钥仍被使用。不使用设备 ID 和设备令牌来验证身份(并获取访问令牌),系统将会提供一个“技术帐户”,可用于请求访问令牌。要引导此过程,则会生成“一次性令牌”。此标识符只能使用一次。帐户信息的消费者将通过 Adobe 服务用一次性令牌交换身份验证令牌。生成的令牌可存储起来以用于将来的身份验证。

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

法律声明   |   在线隐私策略