開始使用 REST APIs

有關一般需求、驗證、可選查詢參數、請求的資訊 URLs和其他參考。

API 需求與建議

使用時，您必須且應該執行的事項 Audience Manager APIs.

使用時請注意下列事項 Audience ManagerAPI 代碼：

• 要求參數： 除非另有指定，否則所有要求參數都是必要的。
• 要求標題:使用 Adobe Developer 代號，您必須提供 x-api-key 頁首。 你可以 API 鍵 服務帳戶整合 頁面。
• JSON內容類型： 指定 content-type: application/json 和 accept: application/json 在程式碼中。
• 請求和回應： 以格式正確的方式傳送請求 JSON 物件。 Audience Manager 回應 JSON 格式化資料。 伺服器回應可包含請求的資料、狀態代碼或兩者。
• 訪問： 您的 Audience Manager 顧問會提供您用戶端ID和金鑰，讓您 API 要求。
• 檔案和程式碼範例： 中的文字 斜體 代表您在產生或接收時提供或傳入的變數 API 資料。 取代 斜體 使用您自己的程式碼、參數或其他必要資訊的文字。

驗證

此 Audience Manager REST APIs 支援兩種驗證方法。

• JWT（服務帳戶）驗證 使用 Adobe Developer. Adobe Developer 是Adobe的開發人員生態系統和社群。 包括 所有Adobe產品的API. 這是設定和使用的建議方式 Adobe APIs.
• OAuth驗證（已廢止）. 雖然此方法已淘汰，但現有的客戶 OAuth 整合可繼續使用此方法。

JWT (Service Account)使用Adobe Developer進行驗證

Adobe Developer概述

Adobe Developer 是Adobe的開發人員生態系統和社群。 包括 所有Adobe產品的API.

這是設定和使用的建議方式 Adobe APIs.

必要條件

設定之前 JWT 驗證，確定您擁有 Adobe Developer Console in Adobe Developer. 如需存取請求，請聯絡貴組織的管理員。

驗證

請依照下列步驟來設定 JWT (Service Account) 驗證使用 Adobe Developer:

1. 登入 Adobe Developer Console.
2. 請依照 服務帳戶連接.
   • 期間 步驟2:使用服務帳戶驗證將API新增至您的專案，選擇 Audience Manager API 選項。
3. 請先嘗試連接 API 根據 步驟3.

技術帳戶RBAC權限

如果您的Audience Manager帳戶使用 角色型存取控制，您必須建立Audience Manager技術使用者帳戶，並將其新增至將進行API呼叫的Audience ManagerRBAC群組。

請依照下列步驟建立技術使用者帳戶，並將其新增至RBAC群組：

1. 建立 GET 呼叫 https://aam.adobe.io/v1/users/self. 此呼叫將建立技術使用者帳戶，您可在 Admin Console，在 Users 頁面。

   

2. 登入您的Audience Manager帳戶，並 新增技術使用者帳戶 至將進行API呼叫的使用者群組。

OAuth 驗證（已廢止）

此 Audience Manager REST API 如下 OAuth 2.0 代號驗證和續約的標準。 以下各節說明如何驗證及開始使用 APIs.

建立通用 API 使用者

建議您建立個別的技術使用者帳戶，以搭配 Audience Manager APIs.這是一般帳戶，不會系結至組織中的特定使用者，或與其建立關聯。 此類 API 使用者帳戶可協助您完成下列兩件事：

• 識別呼叫的服務 API (例如，來自您使用 API或來自其他製造 API 要求)。
• 提供對 APIs.與特定人員系結的帳戶可能會在他們離開您的公司時刪除。 這會使您無法使用可用的 API 程式碼。 未與特定員工綁定的通用帳戶有助於您避免此問題。

作為此類帳戶的範例或使用案例，假設您想要使用 大量管理工具. 為此，您的使用者帳戶需要 API 存取權。 建立非特定的、 API 具有可建立的適當憑證、金鑰和機密的使用者帳戶 API 呼叫。 如果您開發的應用程式使用 Audience Manager APIs.

與您的 Audience Manager 顧問來設定通用， API — 僅限用戶帳戶。

密碼驗證工作流程

密碼驗證安全訪問我們的 REST API. 下列步驟將概述密碼驗證的工作流程，來自 JSON 用戶端。

步驟1:要求 API 存取

請連絡您的合作夥伴解決方案經理。 他們會提供 API 用戶端ID和密碼。 ID和機密會驗證您 API.

注意：如果您想要接收重新整理Token，請在您提出要求時指定 API 存取權。

步驟2:要求Token

使用您偏好的傳遞Token要求 JSON 用戶端。 建置請求時：

• 使用 POST 呼叫方法 https://api.demdex.com/oauth/token.
• 將用戶端ID和密碼轉換為base-64編碼字串。 在轉換過程中以冒號分隔ID和機密。 例如，憑證 testId : testSecret 轉換為 dGVzdElkOnRlc3RTZWNyZXQ=.
• 傳入 HTTP headers Authorization:Basic <base-64 clientID:clientSecret> 和 Content-Type: application/x-www-form-urlencoded . 例如，標題可能如下所示：
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• 設定要求內文，如下所示：
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

步驟3:接收代號

此 JSON 回應包含您的存取權杖。 回應應如下所示：

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

此 expires_in key代表存取權杖過期的秒數。 最佳作法是，如果代號曾公開，請使用短的到期時間來限制曝光。

重新整理Token

重新整理代號續約 API 原始代號過期後的存取。 如有要求，則回應 JSON 在密碼工作流程中包含重新整理Token。 如果您未收到重新整理Token，請透過密碼驗證程式建立新Token。

您也可以使用重新整理Token，在現有存取Token過期之前產生新Token。

如果您的存取權杖已過期，您會收到 401 Status Code 和回應中的下列標題：

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

下列步驟將概述使用重新整理Token，以從 JSON 用戶端。

步驟1:請求新代號

使用您偏好的傳遞重新整理Token請求 JSON 用戶端。 建置請求時：

• 使用 POST 呼叫方法 https://api.demdex.com/oauth/token.
• 將用戶端ID和密碼轉換為base-64編碼字串。 在轉換過程中以冒號分隔ID和機密。 例如，憑證 testId : testSecret 轉換為 dGVzdElkOnRlc3RTZWNyZXQ=.
• 傳入HTTP標題 Authorization:Basic <base-64 clientID:clientSecret> 和 Content-Type: application/x-www-form-urlencoded. 例如，標題可能如下所示：
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• 在請求內文中，指定 grant_type:refresh_token 並傳入您先前存取請求中收到的重新整理Token。 請求應如下所示：
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

步驟2:接收新代號

此 JSON 回應包含您的新存取權杖。 回應應如下所示：

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

授權碼與隱式驗證

此 Audience Manager REST API 支援授權碼和隱式驗證。 若要使用這些存取方法，您的使用者必須登入 https://api.demdex.com/oauth/authorize 以取得存取權並重新整理權杖。

驗證 API 請求

呼叫需求 API 方法。

對可用進行呼叫的方式 API 方法：

• 在 HTTP 標題，設定 Authorization: Bearer <token>.
• 使用時 JWT（服務帳戶）驗證，您必須提供 x-api-key 標題，其與 client_id. 你可以 client_id 從 Adobe Developer整合 頁面。
• 呼叫必要 API 方法。

可選 API 查詢參數

設定可用於方法的可選參數，這些方法將返回對象的所有屬性。

您可以搭配使用這些選用參數 API 傳回的方法 all 對象的屬性。 將查詢傳入至 API.

關於頁面選項的附註

頁面資訊時 不是 指定，則請求會傳回純 JSON 產生陣列。 如果頁面資訊 is 指定，則傳回的清單會包裝在 JSON 包含總結果和當前頁資訊的對象。 使用頁面選項的範例請求看起來可能類似這樣：

GET https://aam.adobe.io/v1/models/?page=1&pageSize=2&search=Test

API URLs

URLs 適用於請求、測試和生產環境及版本。

請求 URLs

下表列出請求 URLs 過去傳入 API 請求，依方法。

您需要根據您使用的驗證方法調整請求 URLs 根據下表。

要求 URLs for JWT 驗證

要求 URLs for OAuth 驗證（已廢止）

環境

此 Audience Manager API提供對不同工作環境的存取。 這些環境可協助您針對個別資料庫測試程式碼，而不會影響即時的生產資料。 下表列出可用 API 環境和對應的資源主機名。

您需要根據您使用的驗證方法調整環境 URLs 根據下表。

版本

新版本 API會定期發行。 新發行將 API 版本號。 請求中參考的版本編號 URL as v<version number> 如下列範例所示：

https://<host>/v1/...

已定義的回應代碼

HTTP 狀態代碼和由返回的響應文本 Audience Manager REST API.

Business.Adobe.com 資源

Third Party Integrations Third Party Data Customer Journey Analytics Mobile Analytics Audience Segmentation General Data Protection Regulation