Autentique e acesse a API do Privacy Service

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

Pré-requisitos prerequisites

Este guia requer entendimento prático do Privacy Service e como ele permite gerenciar o acesso e excluir solicitações de titulares de dados (clientes) nos aplicativos da Adobe Experience Cloud.

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

Coletar valores para cabeçalhos necessários gather-values-required-headers

Para fazer chamadas para a API Privacy Service, primeiro colete 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}

Estes valores são gerados usando o Adobe Developer Console. Seus {ORG_ID} e {API_KEY} só precisam ser gerados uma vez e podem ser reutilizados em chamadas de API futuras. No entanto, seu {ACCESS_TOKEN} é temporário e deve ser gerado novamente a cada 24 horas.

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

Configuração única one-time-setup

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 de API sendo selecionada na lista suspensa Adicionar ao Projeto da página de detalhes do projeto no Developer Console

Selecione a API de Privacy Service select-privacy-service-api

A tela Adicionar uma API é exibida. Selecione Experience Cloud para restringir a lista de APIs disponíveis e, em seguida, selecione o cartão para APIs de Privacy Service antes de selecionar Avançar.

O cartão de API Privacy Service sendo selecionado da lista de APIs disponíveis

TIP
Selecione a opção Exibir documentos para navegar em uma janela de navegador separada para a documentação de referência da API de Privacy Service completa.

Em seguida, selecione o tipo de autenticação para gerar tokens de acesso e acessar a API Privacy Service.

IMPORTANT
Selecione o método OAuth Server-to-Server, pois esse será o único método com suporte no futuro. O método Conta de Serviço (JWT) está obsoleto. Embora as integrações que usam o método de autenticação JWT continuem a funcionar até 1º de janeiro de 2025, a Adobe recomenda que você migre as integrações existentes para o novo método servidor para servidor OAuth antes dessa data. Obtenha mais informações na seção [Obsoleto]{class="badge negative"}Gerar um JSON Web Token (JWT).

Selecione o método de autenticação Oauth de servidor para servidor.

Atribuir permissões por meio de perfis de produto product-profiles

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

NOTE
Os perfis de produto e as permissões granulares que fornecem são criados e gerenciados por administradores por meio do Adobe Admin Console. Consulte o manual sobre permissões de 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 APIs de Privacy Service do projeto exibirá as seguintes credenciais, necessárias em todas as chamadas para APIs de Privacy Service:

  • {API_KEY} (ID do Cliente)
  • {ORG_ID} (ID da Organização)

Informações de integração após adicionar uma API no Developer Console.

Autenticação para cada sessão authentication-each-session

A credencial final necessária que você deve coletar é a {ACCESS_TOKEN}, que é usada no cabeçalho de Autorização. Diferentemente 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 manual-token

Para gerar manualmente um novo {ACCESS_TOKEN}, navegue até Credenciais > Servidor para servidor OAuth e selecione Gerar token de acesso, conforme mostrado abaixo.

Uma gravação de tela sobre como um token de acesso é gerado na interface do usuário do Developer Console.

É 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 Authorization necessário e deve ser fornecido no formato Bearer {ACCESS_TOKEN}.

Geração de token automatizada auto-token

Você também pode usar um ambiente e uma coleção do Postman para gerar tokens de acesso. Para obter mais informações, leia a seção sobre como usar o Postman para autenticar e testar chamadas de API no guia de autenticação de API Experience Platform.

Leitura de chamadas de API de amostra read-sample-api-calls

Cada manual de endpoint fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. 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 chamadas de API de exemplo no guia de introdução para APIs da plataforma.

Próximas etapas next-steps

Agora que você entende quais cabeçalhos usar, você está pronto para começar a fazer chamadas para a API Privacy Service. Selecione um dos manuais de endpoint para começar:

recommendation-more-help
9cbf7061-a312-49f7-aaf8-a10885d53580