Você pode usar o SDK do JavaScript do Ponto de coleta para mapear seu formulário web para a Gestão universal de consentimento e preferências do OneTrust e preferências de aprovação para finalidades de tratamento, tópicos, preferências personalizadas e elementos de dados. A implementação do SDK do Javascript é o método mais simples para coletar registros de consentimento usando um Ponto de coleta de formulário web e fornece um meio rápido para implementar pontos de coleta OneTrust. Para mais informações sobre como mapear um formulário web existente, consulte Como mapear atributos de campo para um formulário web existente.
Nota
Para gerar registros de consentimento, você deve integrar nosso código em seus formulário web ou outros aplicativos do Ponto de coleta. Há dois métodos para integração: um SDK do JavaScript e uma API REST do lado do servidor. O SDK do JavaScript está disponível apenas para Pontos de coleta de formulários web. Para mais informações sobre o método alternativo, consulte Como implementar o Ponto de coleta com REST API.
Visão geral do SDK do JavaScript
O SDK do Javascript do Ponto de coleta é a maneira mais simples de integrar pontos de coleta OneTrust às interfaces existentes. O objetivo do SDK é fornecer a funcionalidade principal com alterações mínimas nas interfaces de formulário web existentes. O SDK deve ser colocado na mesma página que o formulário web que está coletando consentimento. Outra opção é colocar o SDK em qualquer página para a qual o titular dos dados é direcionado depois de enviar o formulário web.
Como integrar o SDK do JavaScript
Você pode usar o SDK do JavaScript do Ponto de coleta para mapear seu formulário web para a Gestão universal de consentimento e preferências do OneTrust e preferências de aprovação para finalidades de tratamento, tópicos, preferências personalizadas e elementos de dados.
Integrar usando o novo método de integração
Você pode utilizar a configuração Nova integração do SDK na tela Detalhes do Ponto de coleta para simplificar a integração do SDK hospedado para Pontos de coleta de formulário web.
-
No menu , selecione . A tela Pontos de coleta é exibida.
-
Clique no link na coluna Nome do Ponto de coleta que você deseja integrar. A tela Detalhes de pontos de coleta é exibida.
-
Vá para a guia SDK. A tela Integração do SDK é exibida.
-
Clique no botão SDK.
-
Habilite a configuração Nova integração do SDK. A seção Integração do SDK é atualizada com as instruções de integração do SDK hospedado atualizadas.
-
Coloque o SDK na tag <head> de uma página web contendo um Ponto de coleta.
-
Clique no botão Copiar correspondente à Etapa 1.
-
Cole o código copiado dentro de uma tag <head> da página web que contém um Ponto de coleta.
-
Adicione o atributo data-ot-cp-id ao(s) formulário(s) que atuarão como Ponto de coleta.
-
Clique no botão Copiar correspondente à versão de Rascunho ou produção do Ponto de coleta na Etapa 2.
-
Adicione o atributo data-ot-cp-id com a ID do ponto de coleta desejada em uma tag <form>.
Integrar usando o Método herdado
-
No menu , selecione . A tela Pontos de coleta é exibida.
-
Clique no link na coluna Nome do Ponto de coleta que você deseja integrar. A tela Detalhes de pontos de coleta é exibida.
-
Vá para a guia SDK. A tela Integração do SDK é exibida.
-
Clique no botão SDK.
-
Clique no botão Copiar SDK e cole o SDK copiado na página de aplicativo do formulário web existente.
-
Configure o SDK para que ele possa identificar os campos para o botão enviar e a caixa de seleção de acionamento condicional (se usada).
-
Quando uma transação é acionada com o SDK, o serviço também retorna um número de transação exclusivo para a página web como um nome de variável JavaScript receiptID.
-
Você pode configurar o SDK para colocar essa variável em um elemento DOM de página, identificando o nome do elemento no JavaScript.
-
Como a ID é gerada antes que o processo normal de envio de formulário seja concluído, você pode passá-la por um campo de formulário oculto para armazenar a receiptID junto com seus registros. Isso permite localizar o registro de transação original no OneTrust e recuperar as informações adicionais armazenadas nele.
Informações e exemplos adicionais
Configurações locais x Configurações hospedadas
O SDK pode ser implementado usando uma das seguintes opções: Configurações do SDK local ou Configurações do SDK hospedado.
-
Configurações do SDK local – A opção Configurações do SDK local inclui os mapeamentos de integração como JavaScript não codificado, que podem ser facilmente modificados para mapear para seu formulário existente depois de copiados.
-
Configurações do SDK hospedado – A opção Configurações do SDK hospedado combina o token de autenticação e as configurações do SDK em um arquivo publicado que é acessado por um URL no script Configurações do SDK. A configuração Usar configurações do SDK hospedado para Pontos de coleta fica ativada por padrão.
A vantagem de usar a opção Configurações do SDK hospedado é que as alterações feitas nos Pontos de coleta são publicadas automaticamente no script de configurações, incluindo quaisquer atualizações para novas versões de finalidades. Ao usar as configurações do SDK hospedado, você poderá atualizar as configurações do seu ponto de coleta sem precisar substituir o SDK integrado em seu site. As configurações serão referenciadas no SDK por meio de um URL para o armazenamento externo.
Principais componentes do SDK do JavaScript
O Ponto de coleta de formulário web no OneTrust gera o código de integração do SDK dinamicamente com base no número de finalidades no Ponto de coleta, no tipo de interação de consentimento, nos idiomas definidos no Ponto de coleta e na configuração Configurações do SDK hospedado.
A seguir estão os principais componentes:
-
Um link para o local do arquivo JavaScript onde a funcionalidade principal do SDK está hospedada.
-
Um token de autenticação JWT usado para verificar a solicitação e garantir a integridade dos registros de transação. O token é atualizado sempre que uma nova versão do Ponto de coleta é salva ou publicada.
-
String de configurações codificadas em base64 que contém o URL a ser chamado ao criar transações.
-
Controles de acionamento personalizáveis
-
Parâmetros adicionais de configurações não codificadas
Nota
Somente esses dois últimos componentes devem ser alterados localmente durante a implementação.
Amostra de SDK e instruções
