Introdução à API do Privacy Service

Este guia fornece uma introdução aos conceitos principais que você precisa saber antes de tentar fazer chamadas para a API do Adobe Experience Platform Privacy Service.

Pré-requisitos

Este guia requer um entendimento prático de Privacy Service e como ele permite gerenciar solicitações de acesso e exclusão de seus titulares de dados (clientes) em todos os aplicativos Adobe Experience Cloud.

Para criar credenciais de acesso para a API, um administrador em sua organização deve ter configurado previamente os perfis de produto para o Privacy Service no Adobe Admin Console. O perfil de produto atribuído a uma integração de API determina quais permissões a integração tem ao acessar recursos do Privacy Service. Consulte o guia sobre gerenciamento de permissões do Privacy Service para obter mais informações.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para a API do Privacy Service, primeiro você deve coletar suas credenciais de acesso para serem usadas nos cabeçalhos necessários:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Esses valores são gerados usando Console do Adobe Developer. Seu {ORG_ID} e {API_KEY} só precisam ser geradas uma vez e podem ser reutilizadas em chamadas de API futuras. No entanto, a variável {ACCESS_TOKEN} é temporária e deve ser regenerada a cada 24 horas.

As etapas de geração desses valores são descritas em detalhes abaixo.

Configuração única

Acesse o Adobe Developer Console e faça logon com seu Adobe ID. Depois, siga as etapas descritas no tutorial sobre como criar um projeto vazio na documentação do Developer Console.

Depois de criar um novo projeto, selecione Adicionar ao projeto e escolha API no menu suspenso.

A opção API que está sendo selecionada na Adicionar ao projeto lista suspensa da página de detalhes do projeto no Console do desenvolvedor

Selecione uma API e gere um par de chaves

A tela Adicionar uma API é exibida. Selecionar Experience Cloud para restringir a lista de APIs disponíveis, selecione o cartão para API Privacy Service antes de selecionar Próximo.

O cartão Privacy Service API que está sendo selecionado na lista de APIs disponíveis

O Configurar API será exibida. Selecione a opção para Gerar um par de chaves, em seguida selecione Gerar par de chaves.

O Gerar um par de chaves opção selecionada na Configurar API tela

O par de chaves é gerado automaticamente e um arquivo ZIP contendo uma chave privada e um certificado público é baixado pelo navegador (para ser usado em uma etapa posterior). Clique em Avançar para continuar.

O par de chaves gerado mostrado na interface do usuário, cujos valores são baixados automaticamente pelo navegador

Atribuir permissões por meio de perfis de produto

A etapa final da configuração é selecionar os perfis de produto dos quais essa integração herdará as permissões. Se você selecionar mais de um perfil, seus conjuntos de permissões serão combinados para a integração.

OBSERVAÇÃO

Os perfis de produto e as permissões granulares fornecidas são criados e gerenciados pelos administradores por meio do Adobe Admin Console. Consulte o guia sobre Permissões para Privacy Service para obter mais informações.

Quando terminar, selecione Salvar API configurada.

Um único perfil de produto sendo selecionado na lista antes de salvar a configuração

Depois que a API for adicionada ao projeto, a página do projeto será exibida novamente no Visão geral da API do Privacy Service página. A partir daqui, role para baixo até o Conta de serviço (JWT) seção , que fornece as seguintes credenciais de acesso que são necessárias em todas as chamadas para a API do Privacy Service:

  • ID DO CLIENTE: A ID do cliente é a {API_KEY} que deve ser previsto no x-api-key cabeçalho.
  • ID DA ORGANIZAÇÃO: a ID da organização é o valor {ORG_ID} que deve ser usado no cabeçalho x-gw-ims-org-id.

Os valores da ID do cliente e da ID da organização , conforme aparecem na página de visão geral do projeto depois que a API é configurada

Autenticação para cada sessão

A credencial final necessária que você deve coletar é a {ACCESS_TOKEN}, que é usada no cabeçalho da Autorização. Diferente dos valores de {API_KEY} e {ORG_ID}, um novo token deve ser gerado a cada 24 horas para continuar usando a API.

Em geral, há dois métodos de geração de um token de acesso:

Gerar um token manualmente

Para gerar manualmente um novo {ACCESS_TOKEN}, abra a chave privada baixada anteriormente e cole seu conteúdo na caixa de texto ao lado de Gerar token de acesso antes de selecionar Gerar token.

O token de acesso gerado anteriormente sendo colado na página de visão geral do projeto, com a variável Gerar token botão que será selecionado depois de

É gerado um novo token de acesso, e é fornecido um botão para copiá-lo para a área de transferência. Esse valor é usado para o cabeçalho de Autorização necessário e deve ser fornecido no formato Bearer {ACCESS_TOKEN}.

O token de acesso gerado que está sendo copiado da interface do usuário

Automatizar a geração de tokens

Você pode gerar novos tokens de acesso para processos automatizados enviando um JSON Web Token (JWT) por meio de uma solicitação POST para o Adobe Identity Management Service (IMS). Consulte o documento do Console do desenvolvedor em Autenticação JWT para obter etapas detalhadas.

Lendo exemplos de chamadas de API

Cada guia de endpoint fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de exemplo retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler exemplos de chamadas de API no guia de introdução para APIs da plataforma.

Próximas etapas

Agora que você sabe quais cabeçalhos usar, está pronto para começar a fazer chamadas para a API do Privacy Service. Selecione um dos guias de ponto de extremidade para começar:

Nesta página