配置Adobe Target API的身份验证

Adobe Target管理员API(包括Recommendations管理员API)通过身份验证进行保护,以确保只有授权用户才能使用它们访问Adobe Target。 使用Adobe开发人员控制台管理所有Adobe Experience Cloud解决方案(包括Target)的此身份验证。

本课程将介绍生成身份验证令牌所需的初步步骤,这些令牌是成功与Adobe Target API交互所需的。 在以下部分中,您将:

  1. 在Adobe开发人员控制台中创建项目(以前称为集成)。
  2. 将项目详细信息导出到Postman。
  3. 生成载体访问令牌。
  4. 测试载体访问令牌。

先决条件

资源 详细信息
邮递员 要成功完成这些步骤,请获取适用于您的操作系统的Postman应用程序。 Postman Basic免费创建帐户。 虽然通常使用Adobe Target API并非必需,但Postman可简化API工作流程,Adobe Target提供了多个Postman集合来帮助执行其API并了解它们的操作方式。 本教程的其余部分假定您具有Postman的工作知识。 如需帮助,请参阅Postman文档
引用 在本教程的其余部分中,我们假定您熟悉以下资源:

创建Adobe I/O项目

在此部分中,您将访问Adobe开发人员控制台并为Adobe Target创建项目。 有关更多信息,请参阅项目文档

  1. Adobe Admin Console中,确保已为您的Adobe用户帐户授予产品管理员开发人员级别访问Target的权限。

  2. Adobe开发人员控制台中,选择要为其创建此集成的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服务。 单击显示的​Next​按钮。

    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开发人员控制台,选择与您在其中使用Recommendations的属性对应的产品配置文件。 (如果您没有使用属性,请选择默认工作区选项。) 单击​保存配置的API
    configure-io-target-createproject9

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

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

configure-io-target-createproject11

注意

在本教程中,我们将项目命名为“Target集成”。 如果您预计项目不仅仅用于Adobe Target,您可能还需要相应地命名它。 例如,您可以选择将其命名为“AdobeAPI”或“Experience CloudAPI”,因为它可以与Adobe Experience Cloud中的其他解决方案一起使用。

导出项目详细信息

现在,您已拥有可用于访问Target的Adobe项目,接下来您需要确保发送该项目的详细信息以及AdobeAPI请求。 要与多个AdobeAPI(包括多个Target API)进行交互,需要提供这些详细信息。 例如,集成详细信息包括Target管理员API所需的授权和身份验证信息。 因此,要将API与Postman结合使用,您需要将这些详细信息导入Postman中。

在Postman中可以通过多种方式指定项目的详细信息,但在此部分中,我们将利用一些预建功能和收藏集。 首先(在此部分中),您会将集成的详细信息导出到Postman环境。 接下来(在以下部分中),您将生成一个载体访问令牌,以授予您访问必要Adobe资源的权限。

注意

有关适用于任何Experience Cloud解决方案(包括Target)的视频说明,请参阅将Postman与Experience PlatformAPI结合使用。 以下各节与Target API相关:

  1. 将Adobe I/O集成详细信息导出到Postman
  2. 使用Postman生成访问令牌

下面还提供了这些步骤。

  1. 仍在Adobe开发人员控制台中,导航以查看新项目的​服务帐户(JWT)​凭据。 使用左侧导航或​Credentials​部分,如所示。
    JWT1
    凭据详细信息​中,请注意,您可 以查看公钥客户端ID​以及与服务帐户相关的其他信息。
    JWT1a

  2. 单击可导航到有关​Adobe Target API的信息。 使用左侧导航或​Connected products and services​部分,如所示。
    JWT2

  3. 单击​Download for Postman > 服务帐户(JWT)​以创建一个JSON文件,用于捕获Postman环境的身份验证信息。
    JWT3
    记下文件系统中的JSON文件。
    JWT3a

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

  5. 选择文件并单击​Open
    JWT5

  6. 在Postman Manage Environments​模式中,单击新导入环境的名称以对其进行检查。 (您的环境名称可能与此处显示的名称不同。 根据需要编辑名称。 它不一定需要匹配Adobe项目的名称。)
    JWT6

  7. 请注意, CLIENT_SECRETAPI_KEY(以及其他变量)已预填充其值,这些值取自您的集成,如Adobe开发人员控制台中所定义。 (Postman CLIENT_SECRET变量应与开发人员控制台中显示的CLIENT SECRETAdobe凭据匹配,而Postman中的API_KEY也应与开发人员控制台中的CLIENT ID匹配。) 相反,注PRIVATE_KEYJWT_TOKENACCESS_TOKEN为空。 我们先提供PRIVATE_KEY值。
    JWT7

    注意

    惊喜!

    小测验! 你记得私钥在哪吗?
    没错,它位于之前从Adobe开发人员控制台下载的config文件中!

  8. 在文件系统中,打开config文件,然后打开private键文件。
    JWT8

  9. 选择并复制private键文件的整个内容。
    JWT9

  10. 在Postman中,将您的私钥值粘贴到​INITIAL VALUE​和​CURRENT VALUE​字段中。
    JWT10

  11. 单击​Update,然后关闭Environments模式窗口。

生成承载访问令牌

在此部分中,您将生成载体访问令牌,该令牌用于验证您与Adobe Target API的交互。 要生成载体访问令牌,您需要将集成详细信息(在前面各节中建立)发送到AdobeIdentity Management服务(IMS)。 可以使用几种不同的方法来实现此目的,但在本教程中,我们让您为IMS API构建一个定制的POST请求。 开个玩笑。 在本教程中,我们将利用包含预建IMS调用的Postman集合,该集合可让流程直接且轻松。 导入收藏集后,您可以根据需要重复使用该收藏集,以便不仅为Adobe Target生成新令牌,还为其他AdobeAPI生成新令牌。

  1. 导航到AdobeIdentity Management服务API调用示例
    令牌1

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

  3. 单击​Raw,然后将生成的JSON复制到剪贴板,以获取此集合的原始JSON。 (或者,您也可以将原始JSON另存为.json文件。)
    令牌3

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

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

    令牌5

    注意

    此载体访问令牌将在24小时内有效。 当您需要生成新令牌时,请再次发送请求。

  6. 再次打开管理环境模式,然后选择您的环境。
    令牌6

  7. 请注意,ACCESS_TOKENJWT_TOKEN值现已填充。
    token7

注意

问:我是否必须使用Adobe I/O访问令牌生成邮递员集合来生成JSON Web令牌(JWT)和载体访问令牌?

答:不! Adobe I/O访问令牌生成Postman集合可方便地在Postman中更轻松地生成JWT和载体访问令牌。 或者,您也可以使用Adobe开发人员控制台中的功能手动生成载体访问令牌。

测试承载访问令牌

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

  1. 导入Adobe Target Admin API邮递员集合。 在将集合导入Postman中之前,请按照所有提示操作。
    testtoken1

  2. 展开集合,并记下​List activities​请求。
    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环境变量的​INITIAL VALUE​和​CURRENT VALUE​字段中。

    testtoken5

    注意

    租户ID与您的Target clientcode不同。 登录到Target后,URL中存在租户ID。 要获取您的租户ID,请登录到Adobe Experience Cloud,打开Target,然后单击Target卡。 按照URL子域中所述,使用租户ID值。

    例如,如果您登录Adobe Target时的URL是

    <https://mycompany.experiencecloud.adobe.com/...>

    则您的租户ID为“mycompany”。

  9. 在确保选择了正确的环境后,发送您的请求。 您应会收到一个包含活动列表的响应。
    testtoken6

恭喜! 现在,您已验证Adobe身份验证,接下来可以使用它与Adobe Target API(以及其他AdobeAPI)进行交互。 例如,您可以使用Recommendations API创建或管理推荐。

在此页面上