Introdução à API do Audience Manager

 

Antes de começar:

Há algumas coisas que você precisa antes de começar a trabalhar com as APIs do AAM. Você vai precisar de:

  • O acesso à API precisa ser concedido.
  • Um ID do cliente (também chamado de Client ID).
  • Uma API secreta.
  • Software para facilitar as solicitações da API (eu recomendo um aplicativo autônomo do Google Chrome chamado Postman, mas outros, incluindo o CuRL, também podem ser usados).

Fale com o seu consultor, ou com a equipe de Atendimento ao cliente do AAM, para obter essas informações.

Depois de obter essas informações, você precisará codificar o ID do cliente e o segredo da API usando a codificação base 64. A string codificada precisa estar no seguinte formato:

clientid:secret

 

Você pode usar um site como base64encode.com para fazer a codificação.

A codificação resultante será algo semelhante a isto: bXljbGllbnRpZDpteWFwaXNlY3JldA==

 

Visão geral do documento:

Clique no link abaixo para ir para essa seção do documento

 

Configurar seu cliente (Postman)

Solicitar um token de acesso

Mais exemplos

 

Configurar seu cliente:

Como foi mencionado anteriormente, existem várias opções diferentes ao escolher um cliente HTTP.  Neste documento, vou me concentrar em um aplicativo autônomo do Chrome chamado Postman.

Você pode obter o Postman aqui: http://www.getpostman.com/

 

O Postman oferece muitos recursos muito legais que tornam a organização ou o trabalho com solicitações HTTP realmente agradáveis.  O aplicativo é dividido em duas seções principais.  À esquerda, há um campo de pesquisa, bem como a capacidade de examinar seu histórico de solicitações e armazenar solicitações em coleções.  O restante do aplicativo é dedicado à compilação e ao envio de solicitações.

 

Criar solicitação no Postman é um processo bastante simples.  Para solicitações HTTP em geral, precisamos saber o tipo de solicitação que faremos, o URL que estamos segmentando e os parâmetros necessários.  Como cada solicitação é diferente, é recomendável consultar a documentação da API para garantir que você tenha as informações necessárias.

 

Observação: antes de poder fazer qualquer pedido em relação à API, você deve primeiro solicitar um token de acesso. Consulte Solicitar um token de acesso para maiores informações.

 

Depois de saber o tipo de solicitação que deseja fazer, comece especificando o tipo de solicitação selecionando-a no menu suspenso.

Em seguida, insira o URL da API no campo URL.  Ela deve ser no formato "https://api.demdex.com/v1/traits/".

A etapa final é definir os parâmetros da solicitação.  Isso é feito inserindo vários valores nas guias "Headers" ou "Body".

 

Os cabeçalhos mudam um pouco dependendo da solicitação enviada, mas geralmente eles contêm os três itens a seguir:

 

  • Accept | application/json
  • Authorization | Bearer <access token>
  • Content-Type | applicaiton/json

O Body também muda dependendo do tipo de solicitação que está sendo enviada, bem como de qual URL (ou endpoint) estamos segmentando.  Geralmente, os valores são fornecidos em um bloco JSON formatado que contém os vários pares de dados.

Com outras solicitações, os valores serão fornecidos em parâmetros.

 

Depois que tudo tiver sido configurado para a solicitação, você poderá enviá-la clicando no botão "Enviar" no canto superior direito ou salvá-la em uma coleção clicando no botão de disco.

 

Solicitar um Token de acesso:

A primeira chamada de API que precisamos fazer é solicitar um token de acesso.  Para fazer isso, enviaremos uma solicitação POST para "https://api.demdex.com/oauth/token".  Como parte do post, precisamos definir vários cabeçalhos e outros parâmetros.

 

URL: https://api.demdex.com/oauth/token

 

Cabeçalhos:

Aceitar: application/json
Autorização: Basic <base 64 encoded token>

 

Tipo de formulário: x-www-form-urlencoded

 

Corpo da solicitação (individual key:value pairs):

grant_type : password
username : <AAM Customer Username>
password : <AAM Customer Password>

 

Curl de exemplo:

curl -X POST -H "Accept: application/json"
-H "Authorization: Basic " -H
"Cache-Control: no-cache" -H "Content-Type:
application/x-www-form-urlencoded" -d
'grant_type=password&username=&password=' https://api.demdex.com/oauth/token

 

Mais exemplos:

Veja alguns exemplos adicionais para ajudá-lo a começar a usar a API.

 

Criação de uma característica:

Tipo de Solicitação HTTP: Post

URL: https://api.demdex.com/v1/traits/ 

Cabeçalhos:

  • Accept: application/json
  • Autorização: Portador <access token>
  • Content-Type: application/json

Corpo da solicitação:

Ao criar uma nova
característica, precisamos definir a estrutura e o tipo de característica, bem como as regras que a característica seguirá.  Alguns dos valores obrigatórios incluem o tipo de característica, o nome da característica, a descrição da característica, a regra da característica, a identificação da fonte de dados e a identificação da pasta principal. Para mais informações, acesse https://marketing.adobe.com/resources/help/en_US/aam/c_methods.html.

{
	"traitType": "RULE_BASED_TRAIT",
	"name": "Blog Post",
	"description": "Tracks when a blog post has been created within the Demo app",
	"comments": "",
	"integrationCode": "post-1",
	"traitRule": "blogPostID==\"1\"",
	"dataSourceId": 14266,
	"folderId": 81659
}

 

Solicitar todas as características baseadas em regras:

HTTP Request Type: Get

URL: https://api.demdex.com/v1/traits/?restrictType=RULE_BASED_TRAIT

Cabeçalhos:

  • Accept: application/json
  • Autorização: Portador <access token>
  • Content-Type: application/json

Solicitar corpo: N/A

 

Documentação de API

Para mais informações sobre o que você pode fazer com as APIs, por favor consulte nossa página de documentação.

Esta obra está licenciada sob uma licença não adaptada da Creative Commons Attribution-Noncommercial-Share Alike 3.0  As publicações do Twitter™ e do Facebook não são cobertas pelos termos do Creative Commons.

Avisos legais   |   Política de privacidade online