验证和访问 Experience Platform API

最近更新： 2025年4月4日
  • 主题：
  • API

创建对象：

  • 开发人员

此文档分步说明了如何获取Adobe Experience Platform开发人员帐户访问权限以调用Experience Platform API。 在本教程结束时，您将生成或收集了所有Experience Platform API调用中作为标头所需的以下凭据：

  • {ACCESS_TOKEN}
  • {API_KEY}
  • {ORG_ID}
TIP
除了上述三个凭据之外，许多Experience Platform API还要求将有效的{SANDBOX_NAME}作为标头提供。 有关沙盒的更多信息，请参阅沙盒概述；有关列出对您的组织可用的沙盒的信息，请参阅沙盒管理端点文档。

为了维护应用程序和用户的安全，对Experience Platform API的所有请求都必须使用OAuth等标准进行身份验证和授权。

本教程介绍如何收集所需的凭据来验证Experience Platform API调用，如下面的流程图中所述。 您可以在初始一次性设置中收集大多数所需的凭据。 但是，必须每24小时刷新一次访问令牌。

一次性初始设置和每个后续会话的身份验证流程要求。

先决条件

要成功调用Experience Platform API，您必须具备以下条件：

  • 有权访问Adobe Experience Platform的组织。
  • 能够将您添加为产品配置文件的开发人员和用户的Admin Console管理员。
  • Experience Platform系统管理员，可以向您授予必要的基于属性的访问控制，以通过API对Experience Platform的不同部分执行读取或写入操作。

您还必须拥有Adobe ID才能完成本教程。 如果您没有Adobe ID，则可以使用以下步骤创建一个：

  1. 转到Adobe Developer Console。
  2. 选择​ 创建新帐户。
  3. 完成注册过程。

获得Experience Platform的开发人员和用户访问权限

在Adobe Developer Console上创建集成之前，您的帐户必须具有Adobe Admin Console中Experience Platform产品配置文件的开发人员和用户权限。

获取开发人员访问权限

请联系贵组织中的Admin Console管理员，将您作为开发人员添加到Experience Platform产品配置文件。 有关如何管理产品配置文件的开发人员访问权限的特定说明，请参阅Admin Console文档。

一旦您被指定为开发人员，就可以开始在Adobe Developer Console中创建集成。 这些集成是从外部应用程序和服务到Adobe API的管道。

获得用户访问权限

您的Admin Console管理员还必须将您作为用户添加到同一产品配置文件。 凭借用户访问权限，您可以在UI中查看您执行的API操作的结果。

有关详细信息，请参阅在Admin Console中管理用户组指南。

生成API密钥（客户端ID）和组织ID

NOTE
如果您是从Privacy Service API指南中跟踪此文档，则现在可以返回该指南以生成Privacy Service唯一的访问凭据。

在通过Admin Console授予您Experience Platform的开发人员和用户访问权限后，下一步是在Adobe Developer Console中生成您的{ORG_ID}和{API_KEY}凭据。 这些凭据只需生成一次，可在未来的Experience Platform API调用中重复使用。

TIP
您可以直接从API参考文档页面获取使用Experience Platform API所需的所有身份验证凭据，而不是转到Developer Console。 参阅更多关于该功能的信息。

将Experience Platform添加到项目

转到Adobe Developer Console并使用您的Adobe ID登录。 接下来，按照Adobe Developer Console文档中有关创建空项目的教程中概述的步骤进行操作。

创建新项目后，请在​ 项目概述 ​屏幕上选择​ 添加API。

TIP
如果您配置了多个组织，请使用界面右上角的组织选择器，以确保您在所需的组织中。

突出显示了“添加API”选项的 Developer Console屏幕。

出现​ 添加API ​屏幕。 选择​ Adobe Experience Platform ​的产品图标，然后选择​ Experience Platform API，然后再选择​ 下一步。

在“添加API”屏幕中选择Experience Platform API。

TIP
选择​ 查看文档 ​选项可在单独的浏览器窗口中导航到完整的Experience Platform API参考文档。

选择OAuth服务器到服务器身份验证类型

接下来，选择​ OAuth服务器到服务器 ​身份验证类型以生成访问令牌并访问Experience Platform API。 在选择​ 下一步 ​之前，请在​ 凭据名称 ​文本字段中为凭据指定有意义的名称。

IMPORTANT
OAuth Server-to-Server ​方法是唯一支持向前发展的令牌生成方法。 以前支持的​ 服务帐户(JWT) ​方法已弃用，无法为新集成选择此方法。 虽然使用JWT身份验证方法的现有集成将继续工作到2025年6月30日，但Adobe强烈建议在该日期之前将现有集成迁移到新的OAuth服务器到服务器方法。 在Deprecated部分获取更多信息{type=negative}生成JSON Web令牌(JWT)。

为Experience Platform API选择OAuth服务器到服务器身份验证方法。