本指南涵蓋 Adobe Customer Journey Analytics (CJA) API,詳細說明資料擷取、自訂解決方案及第三方整合。內容包含存取設定、API 金鑰、Postman 測試、API 呼叫操作範例,以及新手使用建議。
您是 API 新手,想知道Adobe Customer Journey Analytics (CJA) API如何協助您嗎?別擔心!本新手指南將帶您掌握重點、拆解術語,協助您輕鬆踏入 CJA API 的精彩世界。
想像一下,您能夠自動存取並分析 CJA 資料,無須手動操作,這正是 CJA API 所實現的!
- 高效資料擷取:透過 API 呼叫簡化資料擷取流程。
- 自訂解決方案:設計並實作符合業務需求的自動化報表流程。
- 無縫串接:透過穩健整合,實現 CJA 與第三方應用間的順暢資料流。
API 就像訊息傳遞者,將您的請求送到 Adobe 伺服器,再將結果完整帶回。
成功設定
在進行首次 API 呼叫前,請先設定正確的存取權限。首先,確認您已被新增為組織的開發人員。接著,確認您有權存取具備必要權限的產品設定檔。
步驟 1:取得您的 API 金鑰
- 登入 Adobe Developer Console。
- 建立新專案,並將 Customer Journey Analytics API 加入專案,選取所需的產品設定檔。
- 點選 加入專案,同時也將 Adobe Experience Platform API 加入專案
- 完成設定後,您即可在左側的 憑證 標籤下取得所有必要資訊。
以下是所有 API 請求必需的三個重要標頭參數:
- 存取權杖:可確保只有獲授權的使用者能存取資料。您可以點選螢幕擷圖中標示的 產生存取權杖按鈕來產生。此參數在 API 請求中稱為 授權 參數。
- Client ID:也稱為 API 金鑰,在 API 請求中稱為 x-api-key。
- Organization ID:在 API 請求中稱為 x-gw-ims-org-id。
請務必儲存這些認證,這是開啟 API 強大功能的金鑰!如需更詳細的逐步說明,請參閱 CJA API「快速入門」區段。
步驟 2:測試您的設定
若要在不撰寫任何程式碼的情況下測試 API,建議使用功能強大且易於操作的 Postman 工具。啟動應用程式後,您可以輕鬆匯入 API 憑證,並開始嘗試執行簡單的 GET 要求,以確認連線與驗證是否正常運作。建議您從 GET 要求開始進行 API 測試,因為這類要求較為安全且不會造成破壞,只會從伺服器擷取資料而不會進行任何修改。這與其他 HTTP 方法(如 POST、PUT 或 DELETE 要求)不同,後者可能會變更或刪除伺服器上的資料,因此測試時應更加謹慎。
建立您的第一個 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 端點說明文件中,透過 Try It 功能來嘗試這些請求。點此即可嘗試上述請求。
只需點選 Try It CTA,輸入所有必要的參數,此處指的是我們前面討論過的標頭參數,然後按下 Send。
您也可以加入其他參數,以自訂您的請求。每個 API 請求的可用參數清單,請參閱 Query Parameters 區段,詳見 CJA API documentation。
以下是您在使用 API 時常見的主要 HTTP 狀態代碼:
- 200:成功 — 伺服器已成功處理請求並傳回資料
- 404:找不到 — 伺服器找不到所要求的資源
- 500:內部伺服器錯誤 — 伺服器端發生錯誤
這些狀態代碼可讓開發人員清楚了解 API 請求期間發生的情況,有助於排解問題。
API 新手上路小技巧
- 確認您的存取權限:請確保您擁有正確的權限等級,並已加入正確的產品設定檔。權限不足是 API 請求失敗最常見的主因
- 多多測試:建議在 API 端點說明文件或 Postman 中,使用 試用功能,在撰寫程式碼前先進行請求測試。
- 從簡單開始:建議先從簡單的 GET 要求著手,再逐步進行 POST 查詢。
- 善用說明文件:Adobe 的 CJA API 說明文件是您的最佳幫手。請定期查看更新,因為重大更新後,舊有設定可能無法如預期運作。
- 主動發問:如有疑問,歡迎隨時至 Experience League Adobe Analytics 社群尋求協助。
剛開始接觸 Adobe CJA API 可能會感到困難,但只要多加練習,您很快就能自動化工作流程並獲得深度洞察。請立即採取行動,登入、取得您的認證資訊,並嘗試一次簡單的 API 呼叫,開啟您的 API 探索之旅!