配置身份验证 Adobe Target API

此 Adobe Target 管理员API,包括 Recommendations Admin API通过身份验证进行保护,以确保只有授权用户才能使用它们进行访问 Adobe Target. 使用 Adobe Developer控制台 以管理所有用户的此身份验证 Adobe Experience Cloud solutions,包括 Adobe Target.

IMPORTANT
为了支持新的OAuth服务器到服务器凭据,本文中描述的服务帐户(JWT)凭据将被弃用。
服务帐户(JWT)凭据将继续工作到2025年1月1日。 您必须在2025年1月1日之前迁移应用程序或集成,才能使用新的OAuth服务器到服务器凭据。
有关迁移集成的更多信息和分步说明,请参阅 从服务帐户(JWT)凭据迁移到OAuth服务器到服务器凭据开发人员控制台 文档。
有关设置新OAuth凭据的信息,请参阅 OAuth服务器到服务器凭据实施开发人员控制台 文档。

以下是生成与成功交互所需的旧版JWT身份验证令牌所需的初步步骤 Adobe Target API:

  1. 在中创建项目(以前称为集成) Adobe Developer Console.
  2. 将项目详细信息导出到Postman。
  3. 生成持有者访问令牌。
  4. 测试持有者访问令牌。

先决条件

资源
详细信息
Postman
为了成功完成这些步骤,请获取 Postman应用程序 适用于您的操作系统。 Postman basic可在创建帐户时免费使用。 虽然不是要使用 Adobe Target API一般而言,Postman使API工作流更容易,并且 Adobe Target 提供了多个Postman收藏集,以帮助执行其API并了解其操作方式。 本指南的其余部分假定您了解Postman的工作知识。 如需帮助,请参阅 Postman文档.
引用

在本指南的其余部分中,均假定您已熟悉以下资源:

创建Adobe I/O项目

在此部分中,您将访问 Adobe Developer Console 并为创建项目 Adobe Target. 欲了解更多信息,请参见 项目文档.

<!—(1. 根据 身份验证文档.// [//]: #(如中所述 步骤1如何设置AdobeIO:身份验证 — 一步一步. 完成步骤1后,返回本指南并继续执行下面的步骤2。//此步骤的结果应该是创建一个 private.key 文件和 certificate_pub.crt 文件。 生成这两个文件后,请返回本指南。)—>

  1. Adobe Admin Console,确保 Adobe 用户帐户已被授予两者 产品管理员开发人员 级别访问 Target.

  2. Adobe Developer控制台,选择 Experience Cloud组织 ,您要为其创建此集成。 (请注意,您可能只能访问一个 Experience Cloud组织.)

    configure-io-target-createproject2.png

  3. 单击 创建新项目.

    configure-io-target-createproject3.png

  4. 单击 添加API 将REST API添加到您的项目以访问 Adobe 服务及产品。

    添加API

  5. 选择 Adobe Target 作为 Adobe 您希望与集成的服务。 单击 下一个 按钮。

    configure-io-target-createproject5

  6. 选择一个选项,以将公钥和私钥与要为其创建的服务帐户集成关联 Target. 对于此示例,请选择 选项1:生成密钥对 并单击 生成密钥对.

    configure-io-target-createproject6

  7. 按照说明,记下自动下载的配置文件(config),其中包含您的私钥。 单击​ 下一步

    configure-io-target-createproject7

  8. 在您的文件系统中,验证 config,在上一步中创建的压缩配置文件。 同样,这个 config 文件中包含您的私钥,稍后您将需要这些私钥。 文件系统中的确切位置可能与此处显示的位置不同。

    configure-io-target-createproject8

  9. 返回到Adobe Developer Console,选择 产品配置文件 与您在其中使用Adobe Recommendations的属性相对应。 (如果不使用属性,请选择“默认工作区”选项。) 单击 保存配置的API.

    configure-io-target-createproject9

  10. 单击 创建集成. 您应会收到一条临时消息,指示您的API已成功配置。

  11. 最后,将项目重命名为比原始名称更有意义的名称 Project 1. 为此,请使用显示导航路径导航到项目,然后单击 编辑项目 以访问 编辑项目 模式窗口,并重命名项目。

    configure-io-target-createproject11

NOTE
在此示例中,我们将项目命名为“Target 集成。” 如果您预计使用项目的范围不只是 Adobe Target,则可能需要相应地命名它。 例如,您可以选择将其命名为“AdobeAPI”或“Experience CloudAPI”,因为它可与Adobe Experience Cloud中的其他解决方案一起使用。

导出项目详细信息

现在您已经拥有了一个Adobe项目,可以使用它来访问 Target,您需要确保发送该项目的详细信息以及AdobeAPI请求。 要与多个AdobeAPI(包括多个 Target API。 例如,集成详细信息包括 Target 管理员API。 因此,要将API与Postman结合使用,您需要将这些详细信息导入Postman。

可通过多种方式在Postman中指定项目的详细信息,但在本节中,我们利用了某些预建的功能和集合。 首先(在此部分中),您将把集成详情导出到Postman环境中。 接下来(在以下部分中),您将生成持有者访问令牌,以授予您访问必要Adobe资源的权限。

NOTE
有关适用于任何Experience Cloud解决方案的视频说明,包括 Target,请参见 将Postman与Experience PlatformAPI结合使用. 以下部分与 Target API: 1. 创建Experience PlatformAPI并将其导出到Postman 2。 使用Postman生成访问令牌。 以下也提供了这些步骤。
  1. 仍在 Adobe Developer控制台,导航以查看您新项目的 服务帐户(JWT) 凭据。 使用左侧导航或 凭据 部分所示。

    JWT1

    凭据详细信息,请注意,您可以查看 公钥客户端ID,以及与您的服务帐户相关的其他信息。

    JWT1a

  2. 单击可导航至以下内容: Adobe Target API。 使用左侧导航或 连接的产品和服务 部分所示。

    JWT2

  3. 单击 Postman下载 > 服务帐户(JWT) 创建一个JSON文件,用于捕获Postman环境的身份验证信息。

    JWT3

    记下文件系统中的该JSON文件。

    JWT3a

  4. 在Postman中,单击齿轮图标以管理环境,然后单击 导入 导入JSON文件(环境)。

    JWT4

  5. 选择文件并单击 打开.

    JWT5

  6. 在Postman中 管理环境 模式窗口中,单击新导入环境的名称以检查该环境。 (您的环境名称可能与此处显示的名称不同。 根据需要编辑名称。 它不一定需要与 Adobe 项目。)

    JWT6

  7. 注意 CLIENT_SECRETAPI_KEY (以及其他变量)预先填充了它们的值,这些值取自Adobe Developer控制台中定义的集成。 (Postman CLIENT_SECRET 变量应匹配 CLIENT SECRET Adobe在开发人员控制台中显示的凭据,并且 API_KEY 在Postman中也应匹配 CLIENT ID 在开发人员控制台中。) 相比之下,请注意 PRIVATE_KEYJWT_TOKEN、和 ACCESS_TOKEN 为空。 让我们从提供 PRIVATE_KEY 值。

    JWT7

  8. 从您的文件系统打开您的 config 文件,然后打开 private 密钥文件。

    JWT8

  9. 选择并复制 private 密钥文件。

    JWT9

  10. 在Postman中,将私钥值粘贴到 初始值当前值 字段。

    JWT10

  11. 单击 更新,然后关闭Environments模式窗口。

生成持有者访问令牌

在此部分中,您将生成持有者访问令牌,这是对与的交互进行身份验证所必需的 Adobe Target API。 要生成持有者访问令牌,您需要将集成详细信息(在前面部分中建立)发送到 AdobeIdentity Management服务(IMS). 有几种方法可以实现这一点,但在本指南中,我们利用了包含预建IMS调用的Postman集合,该调用可让过程直接而轻松。 导入收藏集后,您可以根据需要重复使用它,以生成新的令牌,而不仅仅是 Adobe Target、以及其他AdobeAPI。

  1. 导航至 AdobeIdentity Management服务API示例调用.

    token1

  2. 单击 Adobe I/O访问令牌生成Postman集合.

    token2

  3. 通过单击获取此收藏集的原始JSON 原始,然后将生成的JSON复制到剪贴板。 (或者,您可以将原始JSON另存为.json文件。)

    token3

  4. 在Postman中,通过粘贴并从剪贴板提交原始JSON来导入收藏集。 (或者,您可以上传已保存的.json文件。) 单击​ 继续

    token4

  5. 选择 IMS:JWT通过用户令牌生成+身份验证 请求生成PostmanAdobe I/O访问令牌收藏集,确保已选择您的环境,然后单击 发送 以生成令牌。

    token5

    note note
    NOTE
    此持有者访问令牌的有效期为24小时。 需要生成新令牌时再次发送请求。
  6. 再次打开管理环境模式窗口,然后选择您的环境。

    token6

  7. 请注意 ACCESS_TOKENJWT_TOKEN 现在填充值。

    token7

问题:我是否需要使用Adobe I/O访问令牌生成Postman集合来生成JSON Web令牌(JWT)和持有者访问令牌?

回答:否。 Adobe I/O访问令牌生成Postman集合可方便地在Postman中更轻松地生成JWT和持有者访问令牌。 或者,您可以使用Adobe Developer控制台中的功能手动生成持有者访问令牌。

测试持有者访问令牌

在本练习中,您将通过发送一个API请求来使用新的持有者访问令牌,该API请求将从您的存储库中检索活动列表 Target 帐户。 成功的响应表示您的 Adobe 项目和身份验证按预期运行,以便使用API。

  1. 导入 Adobe Target 管理员API Postman收藏集. 按照所有提示操作,直到在Postman中导入收藏集为止。

    testtoken1

  2. 展开收藏集,并注意 列出活动 请求。

    testtoken1

  3. 请注意,变量包括 {{access_token}} 最初未解决。 您可以通过多种不同的方式解决此问题 — 例如,您可以定义一个名为的新收藏集变量 {{access_token}} — 但在本指南中,您将更改API请求以利用之前使用的Postman环境。 这将使环境能够继续作为跨AdobeAPI共有的所有变量的单一、一致整合。

    testtoken2

  4. 要替换的类型 {{access_token}} 替换为 {{ACCESS_TOKEN}}.

    testtoken3

  5. 要替换的类型 {{api_key}} 替换为 {{API_KEY}}.

    testtoken4

  6. 要替换的类型 {{tenant}} 替换为 {{TENANT_ID}}. 注意 {{TENANT_ID}} 尚未识别。

    testtoken4

  7. 打开管理环境模式窗口,然后选择您的环境。

    JWT11

  8. 键入以添加新的 {{TENANT_ID}} 环境变量。 将您的租户ID值复制并粘贴到中 初始值当前值 新字段 TENANT_ID 环境变量。

    testtoken5

    note note
    NOTE
    租户ID与您的不同 Target clientcode. 当您登录时,URL中存在租户ID Target. 要获取租户ID,请登录到Adobe Experience Cloud,打开 Target,然后单击Target卡片。 使用URL子域中所述的租户ID值。 例如,如果您在登录到 Adobe Target 是 <https://mycompany.experiencecloud.adobe.com/...> 则您的租户ID为“mycompany”。
  9. 在确保选择了正确的环境后,发送您的请求。 您应会收到包含活动列表的响应。

    testtoken6

现在您已验证Adobe身份验证,可以使用它与 Adobe Target API(以及其他AdobeAPI)。 例如,您可以 使用Recommendations API 创建或管理推荐,或者您可以将其与 Target投放API.

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3