Introdução ao REST APIs getting-started-with-rest-apis

Visão geral do Adobe Developer adobeio

Adobe Developer é um ecossistema e uma comunidade de desenvolvedores do Adobe. Ele inclui APIs para todos os produtos Adobe.

Esta é a maneira recomendada de configurar e usar o Adobe APIs.

Pré-requisitos prerequisites

Antes de configurar a autenticação do JWT, verifique se você tem acesso ao Adobe Developer Console no Adobe Developer. Entre em contato com o administrador da organização para obter solicitações de acesso.

Autenticação auth

Siga as etapas abaixo para configurar a autenticação do JWT (Service Account) usando o Adobe Developer:

1. Faça logon no Adobe Developer Console.
2. Siga as etapas em Conexão com a Conta de Serviço.
   • Durante a Etapa 2: adicionar uma API ao seu projeto usando a autenticação de Conta de Serviço, escolha a opção Audience Manager API.
3. Experimente a conexão fazendo sua primeira chamada do API com base nas instruções da Etapa 3.

Permissões RBAC da conta técnica

Se sua conta Audience Manager usar o Controle de acesso baseado em função, você deverá criar uma conta de usuário técnico Audience Manager e adicioná-la ao grupo Audience Manager RBAC que fará as chamadas de API.

Siga as etapas abaixo para criar uma conta de usuário técnico e adicioná-la a um grupo RBAC:

1. Fazer uma chamada GET para https://aam.adobe.io/v1/users/self. A chamada criará uma conta de usuário técnico que você poderá ver no Admin Console, na página Users.

   

2. Faça logon na sua conta Audience Manager e adicione a conta de usuário técnico ao grupo de usuários que fará as chamadas de API.

O Audience Manager REST API segue os OAuth 2.0 padrões de autenticação e renovação de token. As seções abaixo descrevem como autenticar e começar a trabalhar com o APIs.

Criar um usuário API genérico requirements

Recomendamos que você crie uma conta de usuário técnico separada para trabalhar com o Audience Manager APIs. É uma conta genérica que não está vinculada a um usuário específico na organização nem associada a ele. Este tipo de conta de usuário do API ajuda você a realizar duas coisas:

• Identifique qual serviço está chamando o API (por exemplo, chamadas de seus aplicativos que usam nosso APIs ou de outras ferramentas que fazem API solicitações).
• Forneça acesso ininterrupto ao APIs. Uma conta vinculada a uma pessoa específica pode ser excluída ao ela sair da empresa. Isso impedirá que você trabalhe com o código API disponível. Uma conta genérica que não está vinculada a um funcionário específico ajuda a evitar esse problema.

Como exemplo ou caso de uso para esse tipo de conta, suponhamos que você queira alterar muitos segmentos ao mesmo tempo com as Ferramentas de gerenciamento em massa. Para fazer isso, sua conta de usuário precisa de acesso API. Em vez de adicionar permissões a um usuário específico, crie uma conta de usuário API não específica que tenha as credenciais, a chave e o segredo apropriados para fazer chamadas API. Isso também é útil se você desenvolver seus próprios aplicativos que usam o Audience Manager APIs.

Trabalhe com o consultor do Audience Manager para configurar uma conta de usuário genérica, somente para API.

Fluxo de trabalho de autenticação de senha password-authentication-workflow

Autenticação de senha acesso seguro nosso REST API. As etapas abaixo descrevem o fluxo de trabalho para autenticação de senha de um cliente do JSON em seu navegador.

Etapa 1: solicitar acesso de API

Entre em contato com seu gerente de soluções de parceiros. Eles fornecerão a você uma ID de cliente e um segredo do API. A ID e o segredo autenticam você no API.

Observação: se quiser receber um token de atualização, especifique-o ao solicitar acesso de API.

Etapa 2: solicitar o token

Transmita uma solicitação de token com o cliente JSON de sua preferência. Ao criar a solicitação:

• Use um método POST para chamar https://api.demdex.com/oauth/token.
• Converta a ID do cliente e o segredo em uma sequência de caracteres codificada na base 64. Separe a ID e o segredo com dois pontos durante o processo de conversão. Por exemplo, as credenciais testId : testSecret são convertidas em dGVzdElkOnRlc3RTZWNyZXQ=.
• Passar no HTTP headers Authorization:Basic <base-64 clientID:clientSecret> e Content-Type: application/x-www-form-urlencoded . Por exemplo, seu cabeçalho pode ter esta aparência:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Configure o corpo da solicitação da seguinte maneira:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Etapa 3: Receber o token

A resposta JSON contém seu token de acesso. A resposta deve ser semelhante a:

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

A chave expires_in representa o número de segundos até o token de acesso expirar. Como prática recomendada, use tempos de expiração curtos para limitar a exposição se o token for exposto.

Atualizar token refresh-token

Atualizar tokens renova o acesso API depois que o token original expirar. Se solicitado, a resposta JSON no fluxo de trabalho de senha inclui um token de atualização. Se você não receber um token de atualização, crie um novo por meio do processo de autenticação de senha.

Você também pode usar um token de atualização para gerar um novo token antes que o token de acesso existente expire.

Se o token de acesso tiver expirado, você receberá um 401 Status Code e o seguinte cabeçalho na resposta:

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

As etapas a seguir descrevem o fluxo de trabalho para usar um token de atualização para criar um novo token de acesso a partir de um cliente JSON em seu navegador.

Etapa 1: solicitar o novo token

Transmita uma solicitação de token de atualização com seu cliente JSON preferido. Ao criar a solicitação:

• Use um método POST para chamar https://api.demdex.com/oauth/token.
• Converta a ID do cliente e o segredo em uma sequência de caracteres codificada na base 64. Separe a ID e o segredo com dois pontos durante o processo de conversão. Por exemplo, as credenciais testId : testSecret são convertidas em dGVzdElkOnRlc3RTZWNyZXQ=.
• Passar nos cabeçalhos HTTP Authorization:Basic <base-64 clientID:clientSecret> e Content-Type: application/x-www-form-urlencoded. Por exemplo, seu cabeçalho pode ter esta aparência:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• No corpo da solicitação, especifique o grant_type:refresh_token e transmita o token de atualização recebido na solicitação de acesso anterior. A solicitação deve ter esta aparência:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Etapa 2: receber o novo token

A resposta JSON contém seu novo token de acesso. A resposta deve ser semelhante a:

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

Código de autorização e autenticação implícita authentication-code-implicit

O Audience Manager REST API dá suporte ao código de autorização e à autenticação implícita. Para usar esses métodos de acesso, seus usuários precisam fazer logon no https://api.demdex.com/oauth/authorize para obter acesso e atualizar tokens.