Show Menu
TÓPICOS×

Privacy Service guia do desenvolvedor

O Adobe Experience Platform Privacy Service fornece uma API RESTful e uma interface de usuário que permitem gerenciar (acessar e excluir) os dados pessoais de seus sujeitos de dados (clientes) nos aplicativos da Adobe Experience Cloud. Privacy Service também fornece um mecanismo central de auditoria e registro que permite acessar o status e os resultados de trabalhos que envolvem Experience Cloud aplicativos.
Este guia aborda como usar a Privacy Service API. Para obter detalhes sobre como usar a interface do usuário, consulte a visão geral da interface do Privacy Service. Para obter uma lista abrangente de todos os pontos de extremidade disponíveis na Privacy Service API, consulte a referência da API.

Introdução

Este guia exige um entendimento prático dos seguintes Experience Platform recursos:
  • Privacy Service : Fornece uma API RESTful e uma interface de usuário que permitem gerenciar o acesso e a exclusão de solicitações de seus participantes de dados (clientes) nos aplicativos da Adobe Experience Cloud.
As seções a seguir fornecem informações adicionais que você precisará saber para fazer chamadas bem-sucedidas para a API do Privacy Service.

Lendo chamadas de exemplo da API

Este tutorial 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 amostra retornado em respostas de API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de amostra, consulte a seção sobre como ler chamadas de API de exemplo no guia de Experience Platform solução de problemas.

Reunir valores para cabeçalhos necessários

Para fazer chamadas para a Privacy Service API, primeiro você deve coletar suas credenciais de acesso para serem usadas nos cabeçalhos necessários:
  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Isso envolve obter permissões de desenvolvedor para Experience Platform no Adobe Admin Console e gerar as credenciais no Adobe Developer Console.

Obtenha acesso de desenvolvedor a Experience Platform

Para obter acesso do desenvolvedor ao Platform, siga as etapas iniciais no tutorial de autenticação do Experience Platform. Quando você chegar à etapa "Gerar credenciais de acesso no Adobe Developer Console", volte a este tutorial para gerar as credenciais específicas para Privacy Service.

Gerar credenciais de acesso

Usando o Adobe Developer Console, você deve gerar as três credenciais de acesso a seguir:
  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}
Sua {IMS_ORG} e {API_KEY} só precisam ser geradas uma vez e podem ser reutilizadas em futuras chamadas de API. No entanto, o seu {ACCESS_TOKEN} é temporário e precisa ser regenerado a cada 24 horas.
As etapas para gerar esses valores são abordadas em detalhes abaixo.

Configuração única

Vá para o Adobe Developer Console e faça logon com seu Adobe ID. Em seguida, siga as etapas descritas no tutorial sobre como criar um projeto vazio na documentação do Adobe Developer Console.
Depois de criar um novo projeto, clique em Adicionar API na tela Visão geral _do_projeto.
A tela _Adicionar uma API_é exibida. Selecione​ Privacy Service API ​na lista de APIs disponíveis antes de clicar em​ Avançar .
A tela Configure API (Configurar API ) é exibida. Selecione a opção para​ Gerar um par ​de teclas e clique em​ Gerar um par ​de teclas no canto inferior direito.
O par de chaves é gerado automaticamente e um arquivo ZIP contendo uma chave privada e um certificado público é baixado para o computador local (para ser usado em uma etapa posterior). Selecione Salvar API configurada para concluir a configuração.
Depois que a API for adicionada ao projeto, a página do projeto será exibida novamente na página de visão geral da API do Privacy Service. Aqui, role para baixo até a seção Service Account (JWT) , que fornece as seguintes credenciais de acesso que são necessárias em todas as chamadas para aPrivacy ServiceAPI:
  • ID DO CLIENTE: A ID do cliente é a necessária {API_KEY} para isso, que deve ser fornecida no cabeçalho x-api-key.
  • ID DA ORGANIZAÇÃO: A ID da organização é o {IMS_ORG} valor que deve ser usado no cabeçalho x-gw-ims-org-id.

Autenticação para cada sessão

A credencial final necessária que você deve coletar é sua, {ACCESS_TOKEN} usada no cabeçalho Autorização. Diferentemente dos valores para {API_KEY} e {IMS_ORG} , um novo token deve ser gerado a cada 24 horas para continuar usando Platform APIs.
Para gerar uma nova {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 clicar em​ Gerar token .
Um novo token de acesso é gerado e um botão para copiar o token na área de transferência é fornecido. Esse valor é usado para o cabeçalho de Autorização necessário e deve ser fornecido no formato Bearer {ACCESS_TOKEN} .

Próximas etapas

Agora que você entende quais cabeçalhos devem ser usados, você está pronto para começar a fazer chamadas para a Privacy Service API. O documento em trabalhos de privacidade percorre as várias chamadas de API que você pode fazer usando a Privacy Service API. Cada chamada de exemplo inclui o formato de API geral, uma solicitação de amostra mostrando os cabeçalhos necessários e uma resposta de amostra.