驗證及存取 Experience Platform API

本檔案逐步說明如何存取Adobe Experience Platform開發人員帳戶，進而呼叫Experience Platform API。 在本教學課程結束時，您將已產生或收集下列憑證，這些憑證需要作為所有Platform API呼叫中的標題：

為了維護應用程式和使用者的安全性，對Experience Platform API的所有請求都必須使用OAuth等標準進行驗證和授權。

本教學課程涵蓋如何收集驗證Platform API呼叫所需的認證，如下方流程圖所述。 您可以在初始的一次性設定中收集大部分必要的認證。 然而，存取權杖必須每24小時重新整理一次。

先決條件 prerequisites

為了成功呼叫Experience Platform API，您必須具備下列條件：

您也必須有Adobe ID才能完成本教學課程。 如果您沒有Adobe ID，可以使用下列步驟建立一個：

取得Experience Platform的開發人員和使用者存取權 gain-developer-user-access

在Adobe Developer Console上建立整合之前，您的帳戶必須擁有Adobe Admin Console中Experience Platform產品設定檔的開發人員和使用者許可權。

取得開發人員存取權 gain-developer-access

聯絡 Admin Console 管理員的許可權，使用將您作為開發人員新增至Experience Platform產品設定檔 Admin Console. 請參閱 Admin Console 檔案，以取得關於如何 管理產品設定檔的開發人員存取權.

一旦指派您為開發人員，您就可以開始在中建立整合 Adobe Developer Console. 這些整合是從外部應用程式和服務到Adobe API的管道。

取得使用者存取權 gain-user-access

您的 Admin Console 管理員必須將您作為使用者新增到相同的產品設定檔。 透過使用者存取權，您可以在UI中檢視您執行的API作業的結果。

請參閱以下指南： 管理使用者群組 Admin Console 以取得詳細資訊。

產生API金鑰（使用者端ID）和組織ID generate-credentials

在您透過取得開發人員和使用者的Platform存取權後 Admin Console，下一步是產生 {ORG_ID} 和 {API_KEY} Adobe Developer Console中的認證。 這些認證只需產生一次，並可在未來平台API呼叫中重複使用。

將Experience Platform新增至專案 add-platform-to-project

前往 Adobe Developer Console 並使用您的Adobe ID登入。 接下來，請依照教學課程中概述的步驟進行 建立空白專案 在Adobe Developer Console檔案中。

建立新專案後，選取 新增API 於 專案概述 畫面。

此 新增API 畫面隨即顯示。 選取Adobe Experience Platform的產品圖示，然後選擇 EXPERIENCE PLATFORM API 在選取之前 下一個.

選取 OAuth伺服器對伺服器 驗證型別 select-oauth-server-to-server

接下來，選取 OAuth伺服器對伺服器 驗證型別，以產生存取權杖並存取Experience PlatformAPI。

選取要整合的產品設定檔 select-product-profiles

在 設定API 熒幕，選取 AEP-Default-All-Users.

選取 儲存已設定的API 當您準備好時。

以下的影片教學課程也提供上述步驟的逐步解說，以設定與Experience Platform API的整合：

收集認證 gather-credentials

將API新增至專案後， EXPERIENCE PLATFORM API 專案的頁面會顯示所有Experience PlatformAPI呼叫所需的下列認證：

產生存取權杖 generate-access-token

下一步是產生 {ACCESS_TOKEN} 用於平台API呼叫的認證。 不像 {API_KEY} 和 {ORG_ID}，必須每24小時產生一個新Token才能繼續使用Platform API。 選取 產生存取權杖，如下所示。

[已棄用]{class="badge negative"}產生JSON Web權杖(JWT) jwt

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

測試存取認證 test-credentials

收集完所有三個必要的認證（存取權杖、API金鑰和組織ID）後，您可以嘗試進行下列API呼叫。 此通話會列出所有標準 Experience Data Model (XDM)類別可供您的組織使用。 在中匯入並執行呼叫 Postman.

要求

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: {{ORG_ID}}'

回應

如果您的回應與下方所示的回應類似，表示您的認證有效且運作正常。 （此回應已因空間而遭截斷。）

{
  "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"
    }
  ]
}

取得必要的屬性型存取控制許可權 get-abac-permissions

若要存取或修改Experience Platform中的數個資源，您必須擁有適當的存取控制許可權。 系統管理員可授與您下列許可權： 您需要的許可權. 在本節中取得更多關於 管理角色的API認證.

有關系統管理員如何授與所需許可權以透過API存取Platform資源的詳細資訊，也可在以下教學影片中取得：

使用Postman驗證及測試API呼叫 use-postman

Postman 是常見的工具，可讓開發人員探索和測試RESTful API。 您可以使用Experience Platform Postman集合和環境來加速使用Experience Platform API。 深入瞭解 在Experience Platform中使用Postman 以及開始使用集合和環境。

有關將Postman與Experience Platform集合和環境一起使用的詳細資訊，也可在以下影片教學課程中取得：

下載並匯入Postman環境以搭配Experience Platform API使用

使用Postman集合來產生存取權杖

下載 Identity Management服務Postman集合 並觀看以下影片，瞭解如何產生存取權杖。

下載Experience Platform API Postman集合併與API互動

系統管理員：透過Experience Platform許可權授予開發人員和API存取控制 grant-developer-and-api-access-control

在Adobe Developer Console上建立整合之前，您的帳戶必須擁有Adobe Admin Console中Experience Platform產品設定檔的開發人員和使用者許可權。

將開發人員新增至產品設定檔 add-developers-to-product-profile

前往 Admin Console 並使用您的Adobe ID登入。

選取 產品，然後選取 Adobe Experience Platform 從產品清單中。

從 產品設定檔 索引標籤，選取 AEP-Default-All-Users. 或者，使用搜尋列透過輸入名稱來搜尋產品描述檔。

選取 開發人員 索引標籤，然後選取 新增開發人員.

輸入開發人員的 電子郵件或使用者名稱. 有效的 電子郵件或使用者名稱 將顯示開發人員詳細資訊。 選取「儲存」。

已成功新增開發人員，並出現在 開發人員 標籤。

將API指派給角色

系統管理員可以將API指派給Experience PlatformUI中的角色。

選取 許可權 以及您想要新增API的角色。 選取 API認證 索引標籤，然後選取 新增API認證.

選取您要新增至角色的API，然後選取 儲存.

您將返回 API認證 索引標籤，其中列出新新增的API。

其他資源 additional-resources

請參閱以下連結的其他資源，以取得開始使用Experience PlatformAPI的更多說明

後續步驟 next-steps

閱讀本檔案後，您已收集並成功測試您的Platform API存取認證。 您現在可以跟隨在整個中提供的範例API呼叫 檔案.

除了您在本教學課程中收集的驗證值之外，許多Platform API也需要有效的 {SANDBOX_NAME} 提供為標題。 如需詳細資訊，請參閱沙箱概觀。