驗證並存取 Privacy Service API
本指南介紹您在嘗試呼叫Adobe Experience Platform Privacy Service API之前必須瞭解的核心概念。
先決條件 prerequisites
本指南需要您實際瞭解 Privacy Service 以及它如何讓您管理來自Adobe Experience Cloud應用程式中資料主體(客戶)的存取和刪除請求。
為了建立API的存取認證,您組織內的管理員之前必須設定要在Adobe Admin Console中Privacy Service的產品設定檔。 您指派給API整合的產品設定檔決定在存取Privacy Service功能時,該整合具有哪些許可權。 請參閱以下指南: 管理Privacy Service許可權 以取得詳細資訊。
收集所需標頭的值 gather-values-required-headers
為了呼叫Privacy Service API,您必須先收集要用於必要標題的存取認證:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
這些值的產生方式 Adobe Developer Console. 您的 {ORG_ID}
和 {API_KEY}
只需產生一次,且可在未來API呼叫中重複使用。 不過,您的 {ACCESS_TOKEN}
是暫時性的,必須每24小時重新產生一次。
以下將詳細介紹產生這些值的步驟。
一次性設定 one-time-setup
前往 Adobe Developer Console 並使用您的Adobe ID登入。 接下來,請依照教學課程中概述的步驟進行 建立空白專案 在開發人員控制檯檔案中。
建立新專案後,選取 新增至專案 並選擇 API 下拉式選單中的。
選取Privacy ServiceAPI select-privacy-service-api
此 新增API 畫面隨即顯示。 選取 Experience Cloud 若要縮小可用API的清單,請選取的卡片 PRIVACY SERVICE API 在選取之前 下一個.
接著,選取驗證型別以產生存取權杖並存取Privacy ServiceAPI。
透過產品設定檔指派許可權 product-profiles
最後一個設定步驟是選取此整合將繼承其許可權的產品設定檔。 如果您選取多個設定檔,其許可權集將會結合以進行整合。
完成後,選取 儲存已設定的API.
將API新增至專案後, PRIVACY SERVICE API 專案的頁面會顯示所有Privacy ServiceAPI呼叫所需的下列認證:
{API_KEY}
(使用者端ID){ORG_ID}
(組織ID)
每個工作階段的驗證 authentication-each-session
您必須收集的最終必要認證是 {ACCESS_TOKEN}
,用於Authorization標頭。 不像 {API_KEY}
和 {ORG_ID}
,必須每24小時產生新Token才能繼續使用API。
一般來說,產生存取權杖有兩個方法:
手動產生權杖 manual-token
若要手動產生新的 {ACCESS_TOKEN}
,導覽至 認證 > OAuth伺服器對伺服器 並選取 產生存取權杖,如下所示。
會產生新的存取Token,並提供按鈕以將該Token複製到剪貼簿。 此值用於必要的 Authorization 標題,且必須以格式提供 Bearer {ACCESS_TOKEN}
.
自動化權杖產生 auto-token
您也可以使用Postman環境和集合來產生存取權杖。 如需詳細資訊,請閱讀以下章節: 使用Postman驗證及測試API呼叫 在Experience Platform API驗證指南中。
讀取範例 API 呼叫 read-sample-api-calls
每個端點指南都提供API呼叫範例,示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外,也提供 API 回應中傳回的範例 JSON。 如需檔案中用於範例API呼叫的慣例相關資訊,請參閱以下章節: 如何讀取範例API呼叫 (位於平台API快速入門手冊中)。
後續步驟 next-steps
現在您瞭解要使用哪些標頭,就可以開始呼叫Privacy Service API了。 選取其中一個端點指南以開始: