快速入門 REST APIs getting-started-with-rest-apis

Adobe Developer概觀 adobeio

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

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

必備條件 prerequisites

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

驗證 auth

請依照下列步驟進行設定 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呼叫的使用者群組。

此 Audience Manager REST API 追蹤 OAuth 2.0 權杖驗證和續約的標準。 以下各節將說明如何驗證並開始使用 APIs.

建立一般 API 使用者 requirements

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

• 識別呼叫的服務 API (例如，來自使用我們的應用程式的呼叫 API或從其他製作工具 API 請求)。
• 提供對的不中斷存取 APIs.與特定人員繫結的帳戶可能會在他們離開您的公司時刪除。 這會導致您無法使用可用的 API 程式碼。 未與特定員工繫結的一般帳戶可協助您避免此問題。

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

使用您的 Audience Manager 顧問以設定通用、 API-only使用者帳戶。

密碼驗證工作流程 password-authentication-workflow

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

步驟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 key代表存取Token過期前的秒數。 如果代號公開時，最佳做法就是使用較短的到期時間來限制曝光。

重新整理Token refresh-token

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

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

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

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <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：接收新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"
}

授權代碼和隱含驗證 authentication-code-implicit

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