Identity Service API指南

Adobe Experience Platform Identity Service 通过Adobe Experience Platform中称为“身份图”的方式管理客户的跨设备、跨渠道和近乎实时的身份识别。

快速入门

本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:

  • Identity Service:解决客户个人资料数据碎片化带来的根本挑战。 它通过在客户与您的品牌互动的设备和系统中桥接身份来实现这一点。
  • Real-Time Customer Profile:根据来自多个源的汇总数据,实时提供统一的用户配置文件。
  • Experience Data Model (XDM):用于实现此目标的标准化框架 Platform 组织客户体验数据。

以下部分提供了您需要了解或掌握的其他信息,以便成功调用 Identity Service API。

正在读取示例 API 调用

本指南提供了示例 API 调用来演示如何格式化请求。这些包括路径、必需的标头和格式正确的请求负载。还提供了在 API 响应中返回的示例 JSON。有关文档中用于示例API调用的惯例的信息,请参阅 如何读取示例API调用 在 Experience Platform 疑难解答指南。

收集所需标头的值

为了调用 Platform API,您必须先完成 身份验证教程. 完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值,如下所示:

  • 授权:持有者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

中的所有资源 Experience Platform 被隔离到特定的虚拟沙盒中。 所有请求 Platform API需要一个标头,该标头应指定将在其中执行操作的沙盒的名称:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
有关中沙箱的详细信息 Platform,请参见 沙盒概述文档.

包含负载 (POST、PUT、PATCH) 的所有请求都需要额外的标头:

  • Content-Type: application/json

基于区域的工艺路线

此 Identity Service API采用特定于区域的端点,这些端点需要包含 {REGION} 作为请求路径的一部分。 在您的组织配置过程中,会确定一个区域并将其存储在您的组织配置文件中。 对每个端点使用正确的区域,可确保使用 Identity Service API被路由到适当的区域。

目前有两个区域受支持 Identity Service API:VA7和NLD2。

下表显示了使用区域的示例路径:

服务
地区: VA7
区域: NLD2
Identity Service API
https://platform-va7.adobe.io/data/core/identity/
https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API
https://platform-va7.adobe.io/data/core/idnamespace/
https://platform-nld2.adobe.io/data/core/idnamespace
NOTE
在不指定区域的情况下发出的请求可能会导致呼叫路由到不正确的区域,或导致呼叫意外失败。

如果您无法在组织配置文件中找到该区域,请联系您的系统管理员寻求支持。

使用 Identity Service API

这些服务中使用的标识参数可以采用以下两种方式之一来表示:复合或XID。

复合身份是包括ID值和命名空间在内的结构。 使用复合身份时,命名空间可由任一名称(namespace.code)或ID (namespace.id)。

当一个身份被保存时, Identity Service 生成一个ID并将其分配给该标识,称为本机ID或XID。 群集和映射API的所有变体在其请求和响应中支持复合身份和XID。 需要其中一个参数 — xid 或以下项的组合 [nsnsid] 和 id 以使用这些API。

为了限制响应中的有效负载,API会根据使用的身份构造类型调整其响应。 也就是说,如果传递XID,您的响应将具有XID;如果传递复合身份,则响应将遵循请求中使用的结构。

本文档中的示例不包括 Identity Service API。 有关完整的API,请参阅 Swagger API参考.

NOTE
在请求中使用本机XID时,返回的所有标识都将采用本机XID格式。 建议使用ID/命名空间表单。 有关更多信息,请参阅以下部分: 获取标识的XID.

后续步骤

现在您已经收集了所需的凭据,接下来可以继续阅读开发人员指南的其余部分。 每个部分都提供了有关其端点的重要信息并演示了用于执行CRUD操作的示例API调用。 每个调用都包含常规API格式、一个示例请求(显示所需的标头和格式正确的负载),以及一个成功调用的示例响应。

recommendation-more-help
64963e2a-9d60-4eec-9930-af5aa025f5ea