Adobe Experience Platform Identity Service 在Adobe Experience Platform中管理跨裝置、跨頻道及幾乎即時的客戶身分識別,這稱為「身分圖表」。
本指南需要您深入了解下列 Adobe Experience Platform 元件:
以下小節提供您需瞭解或有手頭的其他資訊,才能成功呼叫 Identity Service API。
本指南提供範例 API 呼叫,示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外,也提供 API 回應中傳回的範例 JSON。 如需文件中用於範例 API 呼叫的慣例相關資訊,請參閱 疑難排解指南中的如何讀取範例 API 呼叫Experience Platform一節。
為了對 Platform API 進行呼叫,您必須先完成驗證教學課程。完成驗證教學課程會提供所有 Experience Platform API 呼叫中每個必要標頭的值,如下所示:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
中的所有資源 Experience Platform 會隔離至特定的虛擬沙箱。 所有要求至 Platform API需要標頭,用以指定將進行作業的沙箱名稱:
{SANDBOX_NAME}
如需中沙箱的詳細資訊 Platform,請參閱 沙箱概述檔案.
所有包含承載 (POST、PUT、PATCH) 的請求都需有額外的標頭:
此 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 |
在沒有指定區域的情況下進行要求,可能會導致呼叫路由到不正確的區域,或導致呼叫意外失敗。
如果您在組織設定檔中找不到地區,請聯絡您的系統管理員以尋求支援。
這些服務中使用的身分引數可以採用以下兩種方式之一來表示:複合或XID。
複合身分是包含ID值和名稱空間的建構。 使用複合身分時,名稱空間可由任一名稱提供(namespace.code
)或ID (namespace.id
)。
當身分持續存在時, Identity Service 會產生並指派一個ID給該身分,稱為原生ID或XID。 Cluster和Mapping API的所有變數在其請求和回應中同時支援複合身分和XID。 需要其中一個引數 — xid
或組合 [ns
或 nsid
] 和 id
以使用這些API。
為了限制回應中的裝載,API會調整其回應,以符合所使用的身分建構型別。 也就是說,如果您傳遞XID,您的回應將具有XID;如果您傳遞複合身分,回應將遵循請求中使用的結構。
本檔案中的範例不涵蓋 Identity Service API。 如需完整的API,請參閱 Swagger API參考.
當請求中使用原生XID時,所有傳回的身分都將採用原生XID格式。 建議使用ID/名稱空間表單。 如需詳細資訊,請參閱以下章節: 取得身分的XID.
現在您已收集到所需的認證,您可以繼續閱讀開發人員指南的其餘部分。 每個區段都提供有關其端點的重要資訊,並示範用於執行CRUD操作的範例API呼叫。 每個呼叫都包含一般API格式、顯示必要標題和正確格式負載的範例請求,以及成功呼叫的範例回應。