Privacy Service 开发人员指南

Adobe Experience Platform Privacy Service 提供了RESTful API和用户界面,允许您跨Adobe Experience Cloud应用程序管理(访问和删除)数据主体(客户)的个人数据。 Privacy Service 还提供了一个中央审计和日志记录机制,允许您访问涉及应用程序的作业的状态和 Experience Cloud 结果。

本指南介绍如何使用 Privacy Service API。 有关如何使用UI的详细信息,请参阅 Privacy ServiceUI概述。 有关API中所有可用端点的全面 Privacy Service 列表,请参阅 API参考

入门指南

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

  • Privacy Service:提供REST风格的API和用户界面,允许您跨Adobe Experience Cloud应用程序管理来自数据主体(客户)的访问和删除请求。

以下各节提供了成功调用Privacy ServiceAPI所需了解的其他信息。

读取示例API调用

本教程提供示例API调用,以演示如何设置请求的格式。 这包括路径、必需的标头和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅疑难解答 指南中有关如何阅读示例API调 用 Experience Platform 一节。

收集所需标题的值

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

  • 授权:承载者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

这包括在Adobe Admin Console获取开 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 屏幕。 在单 “下一步”之前,从可用API的列表中选择 Privacy ServiceAPI

将出 现配置 API屏幕。 选择“Generate a key pair(生成键对)”选 项,然后单击右 下角的“Generate keypair(生成键对)”。

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

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

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

每个会话的身份验证

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

要生成新密 {ACCESS_TOKEN}钥,请打开之前下载的私钥,并将其内容粘贴到“生成访问令牌”旁的 文本框中 ,然后单 击“生成令牌”

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

后续步骤

现在,您已经了解要使用哪些标头,便可开始调用 Privacy Service API。 隐私工作 文档 ,将遍历您可以使用API进行的各种API Privacy Service 调用。 每个示例调用都包括常规API格式、显示所需标头的示例请求和示例响应。

在此页面上