文档Experience Platform标记

身份验证和访问Reactor API

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

要使用Reactor API创建和管理Tags扩展，每个请求都必须包含以下身份验证标头：

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

本指南介绍如何使用Adobe Developer Console收集每个标头的值，以便您开始调用Reactor API。

获取开发人员对Adobe Experience Platform的访问权限 gain-developer-access

在为Reactor API生成身份验证值之前，您必须拥有Experience Platform的开发人员访问权限。 要获得开发人员访问权限，请按照Experience Platform身份验证教程中的开始步骤操作。 完成获取用户访问权限步骤后，返回本教程以生成特定于Reactor API的凭据。

生成访问凭据 generate-access-credentials

使用Adobe Developer Console时，您必须生成以下三个访问凭据：

  • {ORG_ID}
  • {API_KEY}
  • {ACCESS_TOKEN}

贵组织的ID ({ORG_ID})和API密钥({API_KEY})在最初生成后可在以后的API调用中重复使用。 但是，您的访问令牌({ACCESS_TOKEN})是临时的，必须每24小时重新生成一次。

下面详细介绍了生成这些值的步骤。

一次性设置 one-time-setup

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

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

出现​ 添加API ​屏幕。 在选择​ 下一步 ​之前，从可用API列表中选择​ Experience Platform LaunchAPI。

接下来，选择身份验证类型以生成访问令牌并访问Experience PlatformAPI。

IMPORTANT
选择​ OAuth服务器到服务器 ​方法，因为这将是今后唯一支持的方法。 已弃用​ 服务帐户(JWT) ​方法。 虽然使用JWT身份验证方法的集成将继续工作到2025年1月1日，但Adobe强烈建议您在该日期之前将现有集成迁移到新的OAuth服务器到服务器方法。 在[Deprecated]{class="badge informative"}部分获取更多信息{type=negative}在平台API身份验证教程中生成JSON Web令牌(JWT)。

选择​ 下一步 ​以继续。

选择OAuth服务器到服务器身份验证方法。

下一个屏幕提示您选择要与API集成关联的一个或多个产品配置文件。

NOTE
产品配置文件由您的组织通过Adobe Admin Console进行管理，并包含用于精细功能的特定权限集。 产品配置文件及其权限只能由组织中拥有管理员权限的用户管理。 如果您不确定要为API选择哪些产品配置文件，请联系您的管理员。

从列表中选择所需的产品配置文件，然后选择​ 保存配置的API ​以完成API注册。

收集凭据 gather-credentials

将API添加到项目后，项目的​ Experience PlatformAPI ​页面将显示所有调用Experience PlatformAPI时所需的以下凭据：

  • {API_KEY} （客户端ID）
  • {ORG_ID} （组织ID）

在Developer Console中添加API后的 集成信息。

生成访问令牌 generate-access-token

下一步是生成用于Platform API调用的{ACCESS_TOKEN}凭据。 与{API_KEY}和{ORG_ID}的值不同，必须每24小时生成一个新令牌才能继续使用平台API。

TIP
这些令牌会在24小时后过期。 如果将此集成用于应用程序，则最好在应用程序中以编程方式获取持有者令牌。

您可以通过两个选项来生成访问令牌，具体取决于您的用例：

手动生成访问令牌 manual

要手动生成新{ACCESS_TOKEN}，请导航到​ 凭据 > OAuth服务器到服务器，然后选择​ 生成访问令牌，如下所示。

在Developer Console UI中生成和访问令牌方式的屏幕录制。

将生成新的访问令牌，并会提供一个按钮以将令牌复制到剪贴板。 此值用于所需的Authorization标头，必须以Bearer {ACCESS_TOKEN}格式提供。

自动生成令牌 auto-token

您还可以使用Postman环境和收藏集来生成访问令牌。 有关详细信息，请阅读Experience PlatformAPI身份验证指南中有关使用Postman进行身份验证和测试API调用的部分。

测试API凭据 test-api-credentials

按照本教程中的步骤操作，您应该拥有{ORG_ID}、{API_KEY}和{ACCESS_TOKEN}的有效值。 您现在可以通过在对Reactor API的简单cURL请求中使用这些值来测试这些值。

首先尝试对列出所有公司进行API调用。

NOTE
您的组织中可能没有任何公司，在这种情况下，响应将为HTTP状态404（未找到）。 只要您未收到403（禁止）错误，您的访问凭据即有效且正常工作。

确认访问凭据有效后，继续浏览其他API参考文档，了解API的多种功能。

正在读取示例 API 调用 read-sample-api-calls

每个端点指南都提供了示例API调用，以演示如何格式化请求。 这些包括路径、必需的标头和格式正确的请求负载。还提供了在 API 响应中返回的示例 JSON。有关示例API调用文档中使用的约定的信息，请参阅Platform API快速入门指南中有关如何读取示例API调用的部分。

后续步骤 next-steps

现在，您已了解要使用哪些标头，可以开始调用Reactor API了。 选择其中一个端点指南以开始：

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743