设置Developer Console和Postman

在本课程中,您将在Adobe Developer Console中设置一个项目并下载Postman收藏集,以便开始使用平台API。

要完成本教程中的API练习,下载适用于您的操作系统的Postman应用程序。使用Experience PlatformAPI不需要使用Postman,但API工作流更简单,Adobe Experience Platform提供了几十个Postman收藏集来帮助您执行API调用并了解其操作方式。 本教程的其余部分假定您了解Postman的一些工作知识。 如需帮助,请参阅Postman文档

平台是以API优先构建的。 虽然界面选项也适用于所有主要任务,但有时您可能需要使用平台API。 例如,在构建用户界面之前,要摄取数据、在沙盒之间移动项目、自动执行日常任务或使用新Platform功能。

数据架构师 ​和​ 数据工程师 ​可能需要在本教程之外使用平台API。

所需的权限

配置权限课程中,您已设置完成本课程所需的所有访问控制。

设置Adobe Developer Console

Adobe Developer Console是开发人员目标,可用于访问AdobeAPI和SDK、侦听近乎实时的事件、在运行时运行函数或构建插件或App Builder应用程序。 您将使用它来访问Experience PlatformAPI。 有关详细信息,请参阅Adobe Developer Console文档

  1. 在本地计算机上为教程中使用的文件创建一个名为Luma Tutorial Assets的文件夹。

  2. 打开Adobe Developer Console

  3. 登录并确认您所在的组织正确

  4. 在快速入门菜单中选择​ 新建项目

    创建新项目

  5. 在新创建的项目中,选择​ 编辑项目 ​按钮

  6. 将​ 项目标题 ​更改为Luma Tutorial API Project(如果您公司的多个人员正在参加本教程,请添加您的姓名到末尾)

  7. 选择​ 保存

    Adobe Developer Console项目API配置

  8. 选择​ 添加API

    Adobe Developer Console项目API配置

  9. 通过选择​ Adobe Experience Platform ​筛选列表

  10. 在可用API列表中,选择​ Experience PlatformAPI,然后选择​ 下一步

    Adobe Developer Console项目API配置

  11. 选择​ OAuth服务器到服务器 ​作为凭据,然后选择​ 下一步
    选择OAuth服务器到服务器

  12. 选择AEP-Default-All-Users产品配置文件,然后选择​ 保存配置的API

    选择产品配置文件

  13. 现在,您的Developer Console项目已创建!

  14. 在页面的​ 尝试使用 ​部分中,选择​ 下载Postman,然后选择​ OAuth服务器到服务器 ​以下载Postman环境json文件。 将oauth_server_to_server.postman_environment.json保存在您的Luma Tutorial Assets文件夹中。

    Adobe Developer Console项目API配置

让系统管理员将API凭据添加到角色

要使用API凭据与Experience Platform交互,您需要让系统管理员将API凭据分配给在上一课程中创建的角色。 如果您不是系统管理员,请发送以下邮件:

  1. API凭据(Credential in Luma Tutorial API Project)的Name

  2. 凭据的技术帐户电子邮件(这将帮助系统管理员查找凭据)

    你的凭据的 名称和技术帐户电子邮件

以下是系统管理员的说明:

  1. 登录Adobe Experience Platform

  2. 在左侧导航中选择​ 权限,您将转到角色屏幕

  3. 打开Luma Tutorial Platform角色
    打开角色

  4. 选择​ API凭据 ​选项卡

  5. 选择​ 添加API凭据
    添加凭据

  6. 如果列表较长,请使用教程参与者提供的技术帐户电子邮件进行筛选,以查找Credential in Luma Tutorial API Project凭据

  7. 选择凭据

  8. 选择​ 保存

    添加凭据

设置Postman

CAUTION
Postman界面会定期更新。 本教程中的屏幕截图是使用适用于Mac的Postman v10.15.1拍摄的,但界面选项可能已更改。
  1. 下载并安装Postman

  2. 打开Postman并创建工作区
    导入环境

  3. 导入下载的json环境文件oauth_server_to_server.postman_environment.json
    导入环境

  4. 在Postman中,在下拉菜单中选择您的环境

  5. 选择图标以查看环境变量:

    更改环境

添加沙盒名称和租户ID

SANDBOX_NAMETENANT_ID以及CONTAINER_ID变量未包含在Adobe Developer Console导出中,因此我们手动添加它们:

  1. 在Postman中,打开​ 环境变量

  2. 选择环境名称右侧的​ 编辑 ​链接

  3. 在​ 添加新变量字段 ​中,输入SANDBOX_NAME

  4. 在两个值字段中,输入luma-tutorial,即我们在上一课程中为沙盒提供的名称。 如果您对沙盒使用不同的名称,例如luma-tutorial-ignatiusjreilly,请确保使用该值。

  5. 在​ 添加新变量字段 ​中,输入TENANT_ID

  6. 切换到Web浏览器,通过转到Experience Platform的界面并提取@符号​ 之后的URL ​部分,查找您公司的租户ID。 例如,我的租户ID为techmarketingdemos,但您的不同:

    从平台接口URL获取租户ID

  7. 复制此值并返回到Postman管理环境屏幕

  8. 将您的租户ID粘贴到两个值字段中

  9. 在​ 添加新变量字段 ​中,输入CONTAINER_ID

  10. 在两个值字段中输入global

    note note
    NOTE
    CONTAINER_ID是一个字段,其值在教程中多次更改。 使用global时,API会与您Platform帐户中Adobe提供的元素进行交互。 使用tenant时,API与您自己的自定义元素进行交互。
  11. 选择​ 保存

    SANDBOX_NAME、TENANT_ID和CONTAINER_ID字段已添加为环境变量

进行API调用

检索访问令牌

Adobe提供了一组丰富的Postman收藏集,可帮助您探索Experience Platform的API。 这些收藏集位于Adobe Experience Platform Postman Samples GitHub存储库中。 您应该将此存储库加入书签,因为在本教程中,您将多次使用此存储库,稍后当您为自己的公司实施Experience Platform时,也会使用此存储库。

第一个集合适用于AdobeIdentity Management服务(IMS) API。 这是一种从Postman中检索访问令牌的便捷方法。

要生成访问令牌,请执行以下操作:

  1. Identity Management服务API集合下载到您的Luma Tutorial Assets文件夹

  2. 将集合导入Postman

  3. 选择请求​ oAuth:请求访问令牌 ​请求并选择​ 发送

  4. 您应该会在响应中获取带有访问令牌的200 OK响应

    请求令牌

  5. 访问令牌应自动存储为Postman环境的​ ACCESS_TOKEN ​环境变量。

    Postman

与平台API交互

现在,让我们进行Platform API调用,以确认我们正确配置了所有内容。

在GitHub🔗中打开Experience Platform Postman 集合。 此页面上有许多适用于各种Platform API的收藏集。 我强烈建议将它加入书签。

现在,我们进行第一个API调用:

  1. 架构注册表API集合下载到您的Luma Tutorial Assets文件夹
  2. 将其导入Postman
  3. 打开​ 架构注册表API >架构>列表架构
  4. 查看​ Params ​和​ Headers ​选项卡,并注意它们如何包含我们之前输入的一些环境变量。
  5. 请注意,Headers > Accept value字段 ​设置为application/vnd.adobe.xed-id+json。 架构注册表API需要这些指定的接受标头值之一,这些值在响应中提供不同的格式。
  6. 选择​ 发送 ​以进行您的第一个Platform API调用!

希望您获得成功的200 OK响应,其中包含沙盒中可用Adobe提供的XDM架构列表,如下图所示。

Postman中的 第一个API调用

如果您的调用失败,请花些时间使用API调用的错误响应详细信息调试并查看上述步骤。 如果卡住,请在社区论坛中请求帮助,或使用此页面右侧的链接“记录问题”。

设置了Platform权限、沙盒和Postman后,您便可以在架构中建模数据

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad