Show Menu
主題×

驗證及存取Experience Platform API

本檔案提供逐步教學課程,以存取Adobe Experience Platform開發人員帳戶,以呼叫Experience Platform API。

驗證以進行API呼叫

為了維護應用程式和使用者的安全性,對Adobe I/O API的所有要求都必須使用OAuth和JSON Web Token(JWT)等標準進行驗證和授權。 然後,JWT會與用戶端特定資訊一起使用,以產生您的個人存取Token。
本教學課程涵蓋透過建立存取Token來驗證的步驟,其流程圖如下:

必要條件

為了成功呼叫Experience Platform API,您需要下列項目:
  • 可存取Adobe Experience Platform的IMS組織
  • 已註冊的Adobe ID帳戶
  • Admin Console管理員可將您新增為 開發人 員和 產品使用者。
以下各節將逐步說明建立Adobe ID並成為組織的開發人員和使用者的步驟。

建立Adobe ID

如果您沒有Adobe ID,可使用下列步驟建立Adobe ID:
  1. 按一 下建立新帳戶
  2. 完成註冊程式

成為組織Experience Platform的開發人員和使用者

在Adobe I/O上建立整合之前,您的帳戶必須擁有IMS組織中產品的開發人員權限。 有關Admin Console開發人員帳戶的詳細資訊,請參閱管理開發人 員的支援 檔案。
取得開發人員存取權
請連絡您組織中的Admin Console管理員,以便使用 Admin Console將您新增為組織產品的開發人員
管理員必須將您指派為開發人員,以至少指派一個產品設定檔繼續。
一旦您被指派為開發人員,您就擁有在 Adobe I/O上建立整合的存取權限 。 這些整合是從外部應用程式和服務到Adobe API的管道。
取得使用者存取權
您的Admin Console管理員也必須以使用者身分將您新增至產品。
與新增開發人員的程式類似,管理員必須指派您至少一個產品設定檔,才能繼續。

在Adobe Developer Console中產生存取認證

使用Adobe Developer Console,您必須產生下列三種存取憑證:
  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}
您的 {IMS_ORG} API {API_KEY} 只需產生一次,就可在日後的平台API呼叫中重複使用。 但是,您的 {ACCESS_TOKEN} 作業是暫時的,必須每24小時重新生一次。
這些步驟將在下面詳細介紹。

一次性設定

前往 Adobe Developer Console ,使用您的Adobe ID登入。 接著,請依照教學課程中說明的步驟, 在Adobe Developer Console檔案中建立空白的專案
建立新專案後,按一下「專 案概述」畫面上的 「新增API 」。
出現 「Add an API (添加API)」螢幕。 按一下Adobe Experience Platform的產品圖示,然後選取「 Experience Platform API 」,再按 「Next」
在您選取Experience Platform作為要新增至專案的API後,請依照教學課程中所述的步驟,使用服務帳戶( JWT) (從「設定API」步驟開始)將API新增至專案,以完成程式。
將API新增至專案後,「專案概述 __ 」頁面會顯示所有對Experience Platform API的呼叫所需的下列認證:
  • {API_KEY} (用戶端ID)
  • {IMS_ORG} (組織 ID)

每個會話的驗證

您必須收集的最終必要憑證是您的 {ACCESS_TOKEN} 。 與和的值不 {API_KEY} 同, {IMS_ORG} 必須每24小時產生一個新Token,才能繼續使用平台API。
若要產生新 {ACCESS_TOKEN} 的Developer Console認證指南, 請依照步驟產生JWT Token

測試存取認證

收集完所有三個必要的認證後,您可以嘗試進行下列API呼叫。 此呼叫將列出架構註冊表容器內的所有Experience Data Model(XDM)類 global 別:
API格式
GET /global/classes

請求
curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

回應
如果您的回覆與下方所示的類似,則您的認證有效且有效。 (此回應已針對空格截斷。)
{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

使用Postman進行JWT驗證和API呼叫

Postman 是使用REST風格API的常用工具。 此 中篇貼文 ,說明如何設定郵遞員以自動執行JWT驗證,並使用它來使用Adobe Experience Platform API。

後續步驟

閱讀本檔案後,您已收集並成功測試了Platform API的存取認證。 您現在可以遵循檔案中提供的範例API呼
除了您在本教學課程中收集的驗證值之外,許多平台API也需要提供有 {SANDBOX_NAME} 效的標頭。 如需詳細 資訊,請參閱 「沙盒總覽」。