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

Adobe Developer概述 adobeio

Adobe Developer 是Adobe的开发者生态系统和社区。 它包括 适用于所有Adobe产品的API.

这是设置和使用的推荐方式 Adobe APIs.

先决条件 prerequisites

在配置之前 JWT 身份验证，确保您有权访问 Adobe Developer控制台 在 Adobe Developer. 有关访问请求，请联系您的组织管理员。

身份验证 auth

按照以下步骤配置 JWT (Service Account) 身份验证使用 Adobe Developer：

1. 登录到 Adobe Developer控制台.
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表示访问令牌过期前的秒数。 作为最佳实践，如果令牌被公开，请使用较短的过期时间以限制泄露。

刷新令牌 refresh-token

刷新令牌续订 API 在原始令牌过期后访问。 如果要求，响应 JSON 在密码工作流中包含刷新令牌。 如果您没有收到刷新令牌，请通过密码身份验证过程创建一个新令牌。

您还可以使用刷新令牌在现有访问令牌过期之前生成新的令牌。

如果您的访问令牌已过期，您将收到 401 Status Code 和响应中的以下标头：

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

以下步骤概述了使用刷新令牌从创建新访问令牌的工作流 JSON 浏览器中的客户端。

步骤1：请求新令牌

使用您的首选传递刷新令牌请求 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：接收新令牌

此 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 以获取访问权限和刷新令牌。