Informações sobre requisitos gerais, autenticação, parâmetros opcionais de consulta, solicitação URLse outras referências.
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:
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.content-type: application/json
e accept: application/json
em seu código.A variável Audience Manager REST APIs O suporta dois métodos de autenticação.
Dependendo do método de autenticação, é necessário ajustar a solicitação URLs em conformidade. Consulte a Ambientes para obter detalhes sobre os nomes de host que você deve usar.
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.
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.
Siga as etapas abaixo para configurar JWT (Service Account) autenticação usando Adobe Developer:
Para configurar e trabalhar com o Audience Manager REST APIs de maneira automatizada, você pode gerar a variável JWT programaticamente. Consulte Autenticação JWT (conta de serviço) para obter instruções detalhadas.
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:
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.
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.
Audience Manager REST API autenticação e renovação de token via OAuth 2.0 O agora está obsoleto.
Use Autenticação JWT (conta de serviço) em vez disso.
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
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:
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.
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.
Criptografe tokens de acesso e atualização se você armazená-los em um banco de dados.
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.
Transmita uma solicitação de token com o seu JSON cliente. Ao criar a solicitação:
POST
método a ser chamado https://api.demdex.com/oauth/token
.testId : testSecret
converter em dGVzdElkOnRlc3RTZWNyZXQ=
.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
grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>
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 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.
Transmita uma solicitação de token de atualização com sua preferência JSON cliente. Ao criar a solicitação:
POST
método a ser chamado https://api.demdex.com/oauth/token
.testId : testSecret
converter em dGVzdElkOnRlc3RTZWNyZXQ=
.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
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
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"
}
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.
Requisitos de chamada API após receber um token de autenticação.
Para fazer chamadas para o API Métodos:
HTTP
cabeçalho, definir Authorization: Bearer <token>
.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.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.
Parâmetro | Descrição |
---|---|
page |
Retorna resultados por número de página. A numeração começa em 0. |
pageSize |
Define o número de resultados de resposta retornados pela solicitação (10 é o padrão). |
sortBy |
Classifica e retorna resultados de acordo com os valores especificados JSON propriedade. |
descending |
Classifica e retorna resultados em ordem decrescente. ascending é o padrão. |
search |
Retorna resultados com base na cadeia de caracteres especificada que você deseja usar como parâmetro de pesquisa. Por exemplo, digamos que você queira encontrar resultados para todos os modelos que têm a palavra "Teste" em qualquer um dos campos de valor para esse item. Seu exemplo de solicitação pode ser semelhante a: GET https://aam.adobe.io/v1/models/?search=Test . Você pode pesquisar qualquer valor retornado por um "get all". |
folderId |
Retorna todas as IDs para traits dentro da pasta especificada. Não disponível para todos os métodos. |
permissions |
Retorna uma lista de segmentos com base na permissão especificada. READ é o padrão. As permissões incluem:
Especifique várias permissões com pares de valor-chave separados. Por exemplo, para retornar uma lista de segmentos com READ e WRITE somente permissões, transmitir "permissions":"READ" , "permissions":"WRITE" . |
includePermissions |
(Boolean) Defina como true para retornar suas permissões para o segmento. O padrão é false . |
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
URLs para solicitações, ambientes de preparo e produção e versões.
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.
API Métodos | Solicitação URL |
---|---|
Algorithmic Modeling | https://aam.adobe.io/v1/models/ |
Data Source | https://aam.adobe.io/v1/datasources/ |
Derived Signals | https://aam.adobe.io/v1/signals/derived/ |
Destinations | https://aam.adobe.io/v1/destinations/ |
Domains | https://aam.adobe.io/v1/partner-sites/ |
Folders | Características: https://aam.adobe.io/v1/folders/traits / Segmentos: https://aam.adobe.io/v1/folders/segments / |
Schema | https://aam.adobe.io/v1/schemas/ |
Segments | https://aam.adobe.io/v1/segments/ |
Traits | https://aam.adobe.io/v1/traits/ |
Trait Types | https://aam.adobe.io/v1/customer-trait-types |
Taxonomy | https://aam.adobe.io/v1/taxonomies/0/ |
API Métodos | Solicitação URL |
---|---|
Algorithmic Modeling | https://api.demdex.com/v1/models/ |
Data Source | https://api.demdex.com/v1/datasources/ |
Derived Signals | https://api.demdex.com/v1/signals/derived/ |
Destinations | https://api.demdex.com/v1/destinations/ |
Domains | https://api.demdex.com/v1/partner-sites/ |
Folders | Características: https://api.demdex.com/v1/folders/traits / Segmentos: https://api.demdex.com/v1/folders/segments / |
Schema | https://api.demdex.com/v1/schemas/ |
Segments | https://api.demdex.com/v1/segments/ |
Traits | https://api.demdex.com/v1/traits/ |
Trait Types | https://api.demdex.com/v1/customer-trait-types |
Taxonomy | https://api.demdex.com/v1/taxonomies/0/ |
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.
Ambiente | Nome do host para JWT autenticação | Nome do host para OAuth autenticação |
---|---|---|
Produção | https://aam.adobe.io/... |
https://api.demdex.com/... |
Beta | https://aam-beta.adobe.io/... |
https://api-beta.demdex.com/... |
A variável Audience Manager o ambiente beta é uma versão independente e em menor escala do ambiente de produção. Todos os dados que você deseja testar devem ser inseridos e coletados neste ambiente.
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/...
HTTP
códigos de status e texto de resposta retornados pela variável Audience Manager REST API.
ID do código de resposta | Texto da resposta | Definição |
---|---|---|
200 |
OK |
A solicitação foi processada com sucesso. Retornará o conteúdo ou os dados esperados, se necessário. |
201 |
Created |
O recurso foi criado Devoluções para PUT e POST solicitações. |
204 |
No Content |
O recurso foi excluído. O corpo da resposta ficará em branco. |
400 |
Bad Request |
O servidor não entendeu a solicitação. Geralmente devido a sintaxe malformada. Verifique sua solicitação e tente novamente. |
403 |
Forbidden |
Você não tem acesso ao recurso. |
404 |
Not Found |
O recurso não foi encontrado para o caminho especificado. |
409 |
Conflict |
A solicitação não pôde ser concluída devido a um conflito com o estado do recurso. |
500 |
Server Error |
O servidor encontrou um erro inesperado que o impediu de atender à solicitação. |