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呼叫慣例的詳細資訊,請參閱Experience Platform疑難排解指南中如何讀取範例API呼叫一節。

收集所需標頭的值

若要呼叫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)或識別碼(namespace.id)提供名稱空間。

當身分持續存在時,Identity Service會產生識別碼並指派給該身分,稱為原生ID或XID。 Cluster和Mapping 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