Show Menu
主題×

Identity Service API開發人員指南

Adobe Experience Platform可 Identity Service 在Adobe Experience Platform內管理跨裝置、跨通道和近乎即時的客戶身分識別。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件:
以下章節提供您必須知道或掌握的額外資訊,才能成功呼叫 Identity Service API。

讀取範例API呼叫

本指南提供範例API呼叫,以示範如何格式化您的請求。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱疑難排解指 南中有關如何讀取範例API呼叫的 Experience Platform 章節。

收集必要標題的值

若要呼叫API,您必 Platform 須先完成驗證教 學課程 。 完成驗證教學課程後,將提供所有 Experience Platform API呼叫中每個必要標題的值,如下所示:
  • 授權: 生產者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
中的所有資 Experience Platform 源都與特定虛擬沙盒隔離。 對API的所 Platform 有請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:
  • x-sandbox-name: {SANDBOX_NAME}
如需中沙盒的詳細資訊 Platform,請參閱沙 盒概述檔案
所有包含裝載(POST、PUT、PATCH)的請求都需要額外的標題:
  • 內容類型: application/json

基於區域的路由

API Identity Service 採用區域特定的端點,要求在請求路徑 {REGION} 中加入。 在IMS組織布建期間,會決定地區並儲存在IMS組織描述檔中。 使用每個端點的正確區域可確保使用 Identity Service API提出的所有請求都路由到適當的區域。
API目前支援兩個地 Identity Service 區: 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
未指定區域的請求可能導致呼叫路由到錯誤區域,或導致呼叫意外失敗。
如果您無法在IMS組織設定檔中找到地區,請聯絡您的系統管理員以取得支援。

使用 Identity Service API

這些服務中使用的身份參數可以用兩種方式之一表示; 複合或XID。
複合身份是包括ID值和命名空間的構造。 使用複合身份時,名稱空間可以由名稱( namespace.code )或ID( namespace.id )提供。
當身分持續存在時, Identity Service 會產生並指派ID給該身分,稱為原生ID或XID。 所有群集和映射API的變體在其請求和響應中都支援組合身份和XID。 其中一個參數是必要的- xid 或組合或 # 與使 id 用這些API。
為了限制回應中的負載,API會根據使用的身分建構類型來調整其回應。 也就是說,如果您傳遞XID,您的回應會有XID,如果您傳遞複合身分,則回應會遵循請求中使用的結構。
本文中的範例不涵蓋 Identity Service API的完整功能。 如需完整的API,請參閱 Swagger API參考
在請求中使用原生XID時,傳回的所有身分都會以原生XID格式。 建議使用ID/namespace表單。 如需詳細資訊,請參閱有關 取得XID以取得身分的章節

後續步驟

現在您已收集到必要的認證,您可以繼續閱讀其餘的開發人員指南。 每個區段都提供其端點的重要資訊,並示範執行CRUD作業的範例API呼叫。 每個呼叫都包含一般 API格式 、顯示必要標題 和正確格式化負載的範例請求,以及成功呼叫 的範例回應 ​。