开始使用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调用。 此调用将创建一个技术用户帐户，您可以在Admin Console的Users页面中看到该帐户。

   

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

如果您将令牌存储在数据库中，则加密访问和刷新令牌。

步骤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键表示访问令牌过期前的秒数。 作为最佳实践，如果令牌被公开，请使用较短的过期时间以限制泄露。

刷新令牌

刷新令牌在原始令牌过期后续订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"
}

授权代码和隐式身份验证

Audience Manager REST API支持授权代码和隐式身份验证。 若要使用这些访问方法，您的用户需要登录到https://api.demdex.com/oauth/authorize以获取访问权杖并刷新令牌。