本指南涵蓋 Adobe Customer Journey Analytics (CJA) API,詳細介紹了數據擷取、自訂解決方案和第三方整合。其中包含存取設定、API 金鑰、使用 Postman 進行測試、逐步 API 呼叫範例,以及針對初次使用者的提示。

您是 API 新手嗎?想知道 Adobe Customer Journey Analytics (CJA) API 能如何幫助您嗎?不要害怕!在這個對初學者友善的指南中,我們將引導您瞭解基本知識、解釋術語,並協助您邁出令人興奮的第一步,進入 CJA API 世界。

想像一下,您不需要手動操作,就能以程式方式存取和分析 CJA 數據。這正是 CJA API 可以讓您做到的!

將 API 視為信使——它們將您的請求傳送到 Adobe 伺服器,並將結果整齊地封裝帶回來。

設定以取得成功

在執行初次 API 呼叫之前,您需要設定適當的存取權和權限。首先,確保您已新增為組織的開發人員。然後,確認您有可以存取產品設定檔的必要權限。

步驟 1:取得您的 API 金鑰
  1. 登入 Adobe Developer Console
  2. 建立新專案 並將 Customer Journey Analytics API 新增至您的專案,然後選擇所需的產品設定檔。
  3. 按一下 新增至專案 並,將 Adobe Experience Platform API 也新增至專案。
  4. 完成設定後,您就可以在左側的 憑證 標籤下取得所有所需的資訊。

以下是所有 API 請求所需的三個基本標頭參數

請務必儲存這些憑證——它們是您開啟 API 功能的金鑰!更詳細的逐步指示包含在 CJA API 的快速入門部分。

步驟 2:測試您的設定

使用功能強大且使用者友好的工具 Postman 是無需撰寫任何程式碼即可測試 API 的絕佳方式。啟動應用程式後,您可以輕鬆匯入 API 憑證,並開始實驗簡單的 GET 請求,以驗證您的連線和驗證是否正常運作。建議您透過 GET 請求開始 API 測試歷程,這些請求被視為更安全且非破壞性,因為它們只會從伺服器擷取數據,不會進行任何修改。這與 POST、PUT 或 DELETE 請求等其他 HTTP 方法相反,這些方法可能會變更或移除伺服器上的數據,因此在測試時應更謹慎。

進行您的初次 API 呼叫

讓我們做些簡單的事:擷取您 CJA 帳戶中可用的數據視圖清單。

範例:數據視圖清單

端點:
GET https://cja.adobe.io/data/dataviews

標頭:

x-api-key: {API_KEY}

x-gw-ims-org-id: {IMS_ORG_ID}

Authorization: Bearer {AUTHORIZATION_TOKEN}

CURL 請求:

curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\

-H "x-api-key: {API_KEY}" \

-H "x-gw-ims-org-id: {IMS_ORG_ID}" \

-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"

您還可以使用 試用 功能,在 CJA API 端點文件內嘗試這些請求。以下是嘗試上述請求的連結

只要按一下 試用 CTA 並輸入所有必要的參數(在本例中為我們討論過的標頭參數),然後按一下 傳送

您也可以包含其他參數來自訂您的請求。您可以在 CJA API 文件中每個 API 請求的 查詢參數 部分下找到可用參數的清單。

以下是您使用 API 時會遇到的主要 HTTP 回應程式碼:

這些狀態代碼可以準確地告訴開發人員在 API 請求過程中發生了什麼,使問題疑難排解變得更容易。

NOTE
使用 試用 功能時,請確保「授權」欄位中的存取權杖有 'Bearer’ 前置詞。省略或拼錯這個前置詞將導致 401 錯誤。

針對初次 API 使用者的提示

  1. 驗證您的存取權: 確保您擁有正確的權限等級,並已加入正確的產品設定檔。沒有正確的存取權是 API 請求不成功最常見的根本原因
  2. 測試、測試、測試: 使用 API 端點文件中的 試用 功能或 Postman,在撰寫程式碼之前先實驗請求。
  3. 從小處開始: 從簡單的 GET 請求開始,逐步增加到 POST 查詢。
  4. 使用文件: Adobe 的 CJA API 文件是您最好的朋友。定期檢查更新,因為舊設定在重大更新後可能無法如預期運作。
  5. 提出問題: 請隨時聯絡 Experience League Adobe Analytics 社群尋求協助。

開始使用 Adobe CJA API 起初可能會讓人望而生畏,但透過一些實務,您很快就能自動化工作流程並發掘分析。因此,請踏出第一步——登入,取得您的憑證,並嘗試簡單的 API 呼叫。您的 API 冒險正在等著您!

5 分鐘