Introdução ao REST APIs getting-started-with-rest-apis
Informações sobre requisitos gerais, autenticação, parâmetros opcionais de consulta, solicitação URLse outras referências.
Requisitos da API e Recommendations api-requirements-recommendations
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
eaccept: 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 authentication
A variável Audience Manager REST APIs oferecem suporte a três métodos de autenticação.
-
badge positive Recomendado Autenticação de servidor para servidor OAuth usar console do desenvolvedor de Adobe. 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. Leia mais sobre Autenticação de servidor para servidor OAuth na documentação do desenvolvedor do Adobe.
-
badge negative Obsoleto Autenticação JWT (conta de serviço) usar console do desenvolvedor de Adobe. Adobe Developer é um ecossistema de desenvolvedores e comunidade do Adobe. Inclui APIs para todos os produtos Adobe.
-
badge negative Obsoleto Autenticação OAuth herdada. Embora esse método esteja obsoleto, os clientes com OAuth as integrações podem continuar usando esse método.
Autenticação de servidor para servidor OAuth usando Adobe Developer oauth-adobe-developer
Esta seção aborda como coletar as credenciais necessárias para autenticar chamadas de API de Audience Manager, conforme descrito no fluxograma abaixo. Você pode coletar a maioria das credenciais necessárias na configuração inicial única. No entanto, o token de acesso deve ser atualizado a cada 24 horas.
Visão geral do Adobe Developer developer-overview
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 prerequisites-server-to-server
Antes de configurar OAuth Server-to-Server 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 oauth
Siga as etapas abaixo para configurar OAuth Server-to-Server autenticação usando Adobe Developer:
- Faça logon no Console do Adobe Developer.
- Siga as etapas na guia Guia de implementação de credenciais do OAuth de servidor para servidor.
- Durante Etapa 2: adicionar uma API ao projeto usando a autenticação da conta de serviço, escolha o Audience Manager API opção.
- Experimente a conexão fazendo seu primeiro API chame com base nas instruções de Etapa 3.
Adicionar a API do Audience Manager a um projeto add-aam-api-to-project
Ir para Console do Adobe Developer e faça logon com sua Adobe ID. Em seguida, siga as etapas descritas no tutorial em criação de um projeto vazio na documentação do Console do Adobe Developer.
Depois de criar um novo projeto, selecione Add API no Project Overview tela.
A variável Add an API é exibida. Selecione o ícone de produto do Adobe Experience Cloud e escolha Audience Manager API antes de selecionar Next.
Selecione o tipo de autenticação de servidor para servidor OAuth select-oauth-server-to-server
Em seguida, selecione o tipo de autenticação para gerar tokens de acesso e acessar a API Audience Manager.
Selecione os perfis de produto para sua integração select-product-profiles
No Configure API selecione os perfis de produto desejados. A conta de serviço da sua integração terá acesso aos recursos detalhados por meio dos perfis de produto selecionados aqui.
Selecionar Save configured API quando estiver pronto.
Coletar credenciais gather-credentials
Depois que a API for adicionada ao projeto, o Audience Manager API A página do projeto exibe as seguintes credenciais que são necessárias em todas as chamadas para as APIs Audience Manager:
{API_KEY}
(Client ID){ORG_ID}
(Organization ID)
Gerar um token de acesso generate-access-token
A próxima etapa é gerar um {ACCESS_TOKEN}
credencial para uso em chamadas de API Audience Manager. Ao contrário dos valores de {API_KEY}
e {ORG_ID}
, um novo token deve ser gerado a cada 24 horas para continuar usando as APIs Audience Manager. Selecionar Generate access token, conforme mostrado abaixo.
Testar uma chamada de API test-api-call
Depois de obter o token do portador de autenticação, execute uma chamada de API para testar se agora é possível acessar APIs de Audience Manager.
-
Navegue até a Documentação de referência da API.
-
Selecionar Authorize e cole o token de acesso obtido na gerar token de acesso etapa.
-
Execute uma chamada de GET para o
/datasources
endpoint da API para recuperar uma lista de todas as fontes de dados disponíveis globalmente, conforme indicado na Documentação de referência da API. Selecionar Try it out, seguido por Execute, conforme mostrado abaixo.
code language-shell |
---|
|
Ao usar um token de acesso funcional, o endpoint da API retorna uma resposta 200, juntamente com um corpo de resposta que inclui todas as fontes de dados globais às quais sua organização tem acesso.
code language-json |
---|
|
ObsoletoJWT (Service Account) Autenticação usando o Adobe Developer jwt
Visão geral do Adobe Developer adobeio
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 prerequisites
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 auth
Siga as etapas abaixo para configurar JWT (Service Account) autenticação usando Adobe Developer:
- Faça logon no Console do Adobe Developer.
- 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.
- Experimente a conexão fazendo seu primeiro API chame com base nas instruções de Etapa 3.
note note |
---|
NOTE |
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. |
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:
-
Criar um
GET
chamada parahttps://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.
ObsoletoOAuth Autenticação (obsoleta) oauth-deprecated
note warning |
---|
WARNING |
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
Criar um genérico API Usuário requirements
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 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 a partir de um JSON cliente no navegador.
note tip |
---|
TIP |
Criptografe tokens de acesso e atualização se você armazená-los em um banco de dados. |
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 chamadohttps://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 emdGVzdElkOnRlc3RTZWNyZXQ=
. - Transmite no HTTP headers
Authorization:Basic <base-64 clientID:clientSecret>
eContent-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:
code language-json |
---|
|
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 refresh-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 chamadohttps://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 emdGVzdElkOnRlc3RTZWNyZXQ=
. - Passar nos cabeçalhos HTTP
Authorization:Basic <base-64 clientID:clientSecret>
eContent-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:
code language-json |
---|
|
Código de autorização e autenticação implícita authentication-code-implicit
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 authenticated-api-requests
Requisitos de chamada API após receber um token de autenticação.
Para fazer chamadas para o API Métodos:
- No
HTTP
cabeçalho, definirAuthorization: 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 oclient_id
. Você pode obter o seuclient_id
do Integração do Adobe Developer página. - Chame o necessário API método.
Opcional API Parâmetros de consulta optional-api-query-parameters
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.
page
pageSize
sortBy
descending
ascending
é o padrão.search
GET https://aam.adobe.io/v1/models/?search=Test
. Você pode pesquisar qualquer valor retornado por um "get all".folderId
permissions
Retorna uma lista de segmentos com base na permissão especificada. READ
é o padrão. As permissões incluem:
READ
: Retorna e exibe informações sobre um segmento.WRITE
: UsoPUT
para atualizar um segmento.CREATE
: UsoPOST
para criar um segmento.DELETE
: excluir um segmento. Requer acesso a características subjacentes, se houver. Por exemplo, você precisará de direitos para excluir as características que pertencem a um segmento se desejar removê-lo.
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
true
para retornar suas permissões para o segmento. O padrão é false
.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 api-urls
URLs para solicitações, ambientes de preparo e produção e versões.
Solicitação URLs request-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 oRecomendadoObsoletoJWT Autenticação por meio do Adobe Developer request-urls-jwt
https://aam.adobe.io/v1/models/
https://aam.adobe.io/v1/datasources/
https://aam.adobe.io/v1/signals/derived/
https://aam.adobe.io/v1/destinations/
https://aam.adobe.io/v1/partner-sites/
https://aam.adobe.io/v1/folders/traits /
Segmentos:
https://aam.adobe.io/v1/folders/segments /
https://aam.adobe.io/v1/schemas/
https://aam.adobe.io/v1/segments/
https://aam.adobe.io/v1/traits/
https://aam.adobe.io/v1/customer-trait-types
https://aam.adobe.io/v1/taxonomies/0/
Solicitação URLs para oObsoletoOAuth Autenticação request-urls-oauth
https://api.demdex.com/v1/models/
https://api.demdex.com/v1/datasources/
https://api.demdex.com/v1/signals/derived/
https://api.demdex.com/v1/destinations/
https://api.demdex.com/v1/partner-sites/
https://api.demdex.com/v1/folders/traits /
Segmentos:
https://api.demdex.com/v1/folders/segments /
https://api.demdex.com/v1/schemas/
https://api.demdex.com/v1/segments/
https://api.demdex.com/v1/traits/
https://api.demdex.com/v1/customer-trait-types
https://api.demdex.com/v1/taxonomies/0/
Ambientes environments
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.
https://aam.adobe.io/...
https://api.demdex.com/...
https://aam-beta.adobe.io/...
https://api-beta.demdex.com/...
Versões versions
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 response-codes-defined
HTTP
códigos de status e texto de resposta retornados pela variável Audience Manager REST API.
200
OK
201
Created
PUT
e POST
solicitações.204
No Content
400
Bad Request
403
Forbidden
404
Not Found
409
Conflict
500
Server Error