開始使用REST APIs

Adobe Developer概觀

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

這是設定及使用Adobe APIs的建議方式。

必備條件

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

驗證

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

1. 登入Adobe Developer Console。
2. 請依照服務帳戶連線中的步驟操作。
   • 在步驟2：使用服務帳戶驗證新增API至您的專案，請選擇Audience Manager API選項。
3. 根據步驟3的指示，進行您的第一個API呼叫以嘗試連線。

NOTE

若要以自動方式設定及使用Audience Manager REST APIs，您可以以程式設計方式產生JWT。 如需詳細指示，請參閱JWT （服務帳戶）驗證。

技術帳戶RBAC許可權

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

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

1. 對https://aam.adobe.io/v1/users/self進行GET呼叫。 通話將會建立您可以在Users頁面的Admin Console中看到的技術使用者帳戶。

   

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

WARNING

Audience Manager REST API權杖驗證和透過OAuth 2.0的續約現在已被取代。

請改用JWT （服務帳戶）驗證。

Audience Manager REST API遵循權杖驗證和更新的OAuth 2.0標準。 以下各節說明如何驗證並開始使用API。

建立一般API使用者

建議您建立個別的技術使用者帳戶來使用Audience Manager API。這是一般帳戶，不會繫結至組織中的特定使用者或與其相關聯。 此型別的API使用者帳戶可協助您完成2件事：

• 識別呼叫API的服務（例如，使用我們API的應用程式呼叫，或其他發出API要求的工具呼叫）。
• 提供對API的不中斷存取。繫結至特定人員的帳戶可能會在離開您的公司時刪除。 這會使您無法使用可用的API程式碼。 未與特定員工繫結的一般帳戶可協助您避免此問題。

此型別帳戶的範例或使用案例，假設您想使用大量管理工具一次變更許多區段。 若要這麼做，您的使用者帳戶需要API存取權。 請建立具有適當認證、金鑰和密碼的非特定API使用者帳戶，以進行API呼叫，而不新增許可權給特定使用者。 如果您開發自己的使用Audience Manager API的應用程式，這也很有用。

與您的Audience Manager顧問合作，設定僅限API的通用使用者帳戶。

密碼驗證工作流程

密碼驗證可安全存取我們的REST API。 以下步驟概述來自瀏覽器中JSON使用者端的密碼驗證工作流程。

TIP

如果您將Token儲存在資料庫中，請加密存取並重新整理Token。

步驟1：要求API存取權

請連絡您的合作夥伴解決方案經理。 他們將會提供API使用者端ID和密碼。 ID和密碼會驗證API的身份。

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

步驟2：要求權杖

傳入權杖要求給您偏好的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金鑰代表存取Token到期前的秒數。 如果代號公開時，最佳做法就是使用較短的到期時間來限制曝光。

重新整理Token

重新整理Token在原始的Token過期後更新API存取權。 若有要求，密碼工作流程中的回應JSON會包含重新整理權杖。 如果您沒有收到重新整理權杖，請透過密碼驗證程式建立新的權杖。

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

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

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

下列步驟概述使用重新整理權杖從瀏覽器中的JSON使用者端建立新存取權杖的工作流程。

步驟1：要求新Token

傳入重新整理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並傳入您先前存取要求中收到的重新整理權杖。 要求應該如下所示：
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

步驟2：接收新Token

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才能取得存取權杖並重新整理。