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 uma compreensão funcional de 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 guia 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}
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, 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.
Selecione a API de Privacy Service select-privacy-service-api
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óxima.
Em seguida, selecione o tipo de autenticação para gerar tokens de acesso e acessar a API Privacy Service.
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.
Quando terminar, selecione Salvar API configurada.
Depois que a API for adicionada ao projeto, o API PRIVACY SERVICE A página do projeto exibe as seguintes credenciais que são necessárias em todas as chamadas para as APIs Privacy Service:
{API_KEY}(ID do cliente){ORG_ID}(ID da organização)
Autenticação para cada sessão authentication-each-session
A credencial final necessária que você deve coletar é sua {ACCESS_TOKEN}, que é usado no cabeçalho Autorização. Ao contrário 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 o token manualmente para testes e desenvolvimento.
- Geração de token automatizada para integrações de API.
Gerar um token manualmente manual-token
Para gerar manualmente um novo {ACCESS_TOKEN}, navegue até Credenciais > Servidor OAuth para servidor e selecione Gerar token de acesso, conforme mostrado abaixo.
É 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 uso do Postman para autenticar e testar chamadas de API no guia de autenticação da API do 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 às APIs da Platform.
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: