Privacy ServiceAPI快速入门

本指南简要介绍在尝试调用Privacy ServiceAPI之前需要了解的核心概念。

先决条件

本指南需要了解以下功能:

收集所需标题的值

要调用Privacy ServiceAPI,必须先收集要在所需标头中使用的访问凭据:

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

这包括在Adobe Admin Console中获取Adobe Experience Platform的开发人员权限,然后在Adobe开发人员控制台中生成凭据。

获取开发人员访问Experience Platform

要获取开发人员访问 Platform,请按照 Experience Platform身份验证教程. 进入“在Adobe开发人员控制台中生成访问凭据”步骤后,请返回本教程以生成特定于Privacy Service的凭据。

生成访问凭据

使用Adobe开发人员控制台,您必须生成以下三个访问凭据:

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

您的 {IMS_ORG}{API_KEY} 只需生成一次,便可在将来的API调用中重复使用。 但是,您的 {ACCESS_TOKEN} 是临时的,必须每24小时重新生一次。

有关生成这些值的步骤,请参见下文。

一次性设置

转到 Adobe开发人员控制台 然后使用您的Adobe ID登录。 接下来,按照 创建空项目 中的Adobe开发人员控制台文档。

创建新项目后,选择 添加API项目概述 屏幕。

添加API 屏幕。 选择 Privacy ServiceAPI 从可用API列表中选择 下一个.

配置API 屏幕。 选择要 生成键对,然后选择 生成密钥对 在右下角。

密钥对将自动生成,并将包含私钥和公共证书的ZIP文件下载到本地计算机(将在稍后的步骤中使用)。 选择 保存配置的API 以完成配置。

将API添加到项目后,项目页面会重新显示在 Privacy ServiceAPI概述 页面。 从此处,向下滚动到 服务帐户(JWT) 部分,该部分提供了所有Privacy ServiceAPI调用中所需的以下访问凭据:

  • 客户端ID:客户ID是必需的 {API_KEY} ,则必须在x-api-key标头中提供。
  • 组织ID:组织ID是 {IMS_ORG} 必须在x-gw-ims-org-id标头中使用的值。

每个会话的身份验证

您必须收集的最终所需凭据是 {ACCESS_TOKEN},用于授权标头。 与 {API_KEY}{IMS_ORG},则必须每24小时生成一个新令牌,才能继续使用 Platform API。

生成新 {ACCESS_TOKEN},打开之前下载的私钥并将其内容粘贴到旁边的文本框中 生成访问令牌 选择 生成令牌.

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

读取示例API调用

本教程提供了用于演示如何设置请求格式的示例API调用。 这包括路径、所需标头以及格式正确的请求负载。 还提供了API响应中返回的示例JSON。 有关示例API调用文档中使用的约定的信息,请参阅 如何阅读示例API调用 平台API快速入门指南中的。

后续步骤

现在,您已经了解要使用哪些标头,接下来便可以开始调用Privacy ServiceAPI。 选择要开始使用的端点指南之一:

在此页面上