Introdução ao REST APIs

Informações sobre requisitos gerais, autenticação, parâmetros opcionais de consulta, solicitação URLse outras referências.

Requisitos da API e recomendações

Coisas que você deve e deve fazer ao trabalhar com a Audience Manager APIs

Observe o seguinte ao trabalhar com o API AUDIENCE MANAGER código:

• Parâmetros de solicitação: todos os parâmetros de solicitação são obrigatórios, a menos que especificado de outra forma.
• Cabeçalhos de solicitação: ao usar Adobe Developer tokens, você deve fornecer a x-api-key cabeçalho. Você pode obter o seu API seguindo as instruções na caixa Integração da Conta de Serviço página.
• JSONtipo de conteúdo: Especificar content-type: application/json e accept: application/json em seu código.
• Solicitações e respostas: Enviar solicitações como um formulário corretamente formatado JSON objeto. Audience Manager responde com JSON dados formatados. As respostas do servidor podem conter dados solicitados, um código de status ou ambos.
• Acesso: Seu Audience Manager consultor fornecerá uma ID do cliente e uma chave que permitirá que você faça API solicitações.
• Documentação e amostras de código: Texto em itálico representa uma variável que você fornece ou transmite ao criar ou receber API dados. Substituir itálico texto com seu próprio código, parâmetros ou outras informações necessárias.

Autenticação

A variável Audience Manager REST APIs O suporta dois métodos de autenticação.

• Autenticação JWT (conta de serviço) usar Adobe Developer. Adobe Developer é um ecossistema de desenvolvedores e comunidade do Adobe. Inclui APIs para todos os produtos Adobe. Essa é a maneira recomendada de configurar e usar o Adobe APIs.
• Autenticação OAuth (obsoleto). Embora esse método esteja obsoleto, os clientes com OAuth as integrações podem continuar usando esse método.

JWT (Service Account) Autenticação usando o Adobe Developer

Visão geral do Adobe Developer

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

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

Pré-requisitos

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

Autenticação

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

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

Permissões RBAC da conta técnica

Se sua conta Audience Manager usa Controle de acesso baseado em função, você deve 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. Criar um GET chamada para https://aam.adobe.io/v1/users/self. A chamada criará uma conta de usuário técnico que pode ser vista na variável Admin Console, no Users página.

   

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

OAuth Autenticação (obsoleta)

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

Criar um genérico API Usuário

Recomendamos que você crie uma conta de usuário técnica separada para trabalhar com a 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. Esse tipo de API A conta de usuário do ajuda você a realizar duas coisas:

• Identificar o serviço que está chamando o API (por exemplo, chamadas de seus aplicativos que usam nossa APIs ou de outras ferramentas que API pedidos).
• Fornecer acesso ininterrupto à APIs. Uma conta vinculada a uma pessoa específica pode ser excluída ao sair da empresa. Isso impedirá que você trabalhe com os API código. 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, considere que você deseja alterar muitos segmentos de uma só vez com o Ferramentas de gerenciamento em massa. Bem, para fazer isso, sua conta de usuário precisa API acesso. Em vez de adicionar permissões a um usuário específico, crie um API conta de usuário que tenha as credenciais, a chave e o segredo apropriados para fazer API chamadas. Isso também é útil se você desenvolver seus próprios aplicativos que usam o Audience Manager APIs

Trabalhe com o seu Audience Manager consultor para configurar um genérico, APIconta de usuário somente do.

Fluxo de trabalho de autenticação de senha

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

Etapa 1: solicitação API Access

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

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

Etapa 2: solicitar o token

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

• Use um POST método a ser chamado 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 testId : testSecret converter em dGVzdElkOnRlc3RTZWNyZXQ=.
• Transmite 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 variável JSON A resposta contém o 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 variável expires_in A chave 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

Atualizar tokens renovar API depois que o token original expirar. Se solicitado, a resposta será 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 JSON cliente no navegador.

Etapa 1: solicitar o novo token

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

• Use um POST método a ser chamado 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 testId : testSecret converter 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 variável JSON A resposta contém o 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

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

Tornar autenticado API Solicitações

Requisitos de chamada API após receber um token de autenticação.

Para fazer chamadas para o API Métodos:

• No HTTP cabeçalho, definir Authorization: Bearer <token>.
• Ao usar Autenticação JWT (conta de serviço), é necessário fornecer a x-api-key cabeçalho, que será o mesmo que o client_id. Você pode obter o seu client_id do Integração do Adobe Developer página.
• Chame o necessário API método.

Opcional API Parâmetros de consulta

Defina os parâmetros opcionais disponíveis para métodos que retornam todas as propriedades de um objeto.

Você pode usar esses parâmetros opcionais com API métodos que retornam all propriedades de um objeto. Defina essas opções na string de solicitação ao transmitir essa consulta para o API.

Uma Observação Sobre As Opções De Página

Quando as informações da página não é especificada, a solicitação retorna simples JSON resulta em uma matriz. Se as informações da página é especificada, a lista retornada é encapsulada em uma variável JSON objeto que contém informações sobre o resultado total e a página atual. O exemplo de solicitação usando opções de página pode ser semelhante a:

GET https://aam.adobe.io/v1/models/?page=1&pageSize=2&search=Test

API URLs

URLs para solicitações, ambientes de preparo e produção e versões.

Solicitação URLs

A tabela a seguir lista a solicitação URLs usado para transmitir API por método.

Dependendo do método de autenticação usado, é necessário ajustar a solicitação URLs de acordo com as tabelas abaixo.

Solicitação URLs para JWT Autenticação

Solicitação URLs para OAuth Autenticação (obsoleta)

Ambientes

A variável Audience Manager APIAs fornecem acesso a diferentes ambientes de trabalho. Esses ambientes ajudam a testar o código em bancos de dados separados, sem afetar os dados de produção em tempo real. A tabela a seguir lista os API ambientes e nomes de host de recursos correspondentes.

Dependendo do método de autenticação usado, é necessário ajustar o ambiente URLs de acordo com o quadro abaixo.

Versões

Novas versões desses APIOs s são lançados regularmente. Uma nova versão aprimora o API número da versão. O número da versão é referenciado na solicitação URL as v<version number> como mostrado no exemplo a seguir:

https://<host>/v1/...

Códigos de resposta definidos

HTTP códigos de status e texto de resposta retornados pela variável Audience Manager REST API.

Recursos do Business.Adobe.com

Third Party Integrations Third Party Data Customer Journey Analytics Mobile Analytics Audience Segmentation General Data Protection Regulation