O que é?
Esta área é dedicada exclusivamente para à orientação de desenvolvedores e integradores da plataforma PrivacyTools em sistemas. Caso você busque por suporte técnico faça a abertura de um chamado em https://www.privacytools.com.br/help/
Passo a Passo
| Table of Contents | ||
|---|---|---|
|
Variáveis e
chavesChaves
Para utilização da utilizar a API e o SDK abaixo, você precisará ter em mãos algumas chaves ou códigos que estão disponíveis na conta da sua plataforma da PrivacyTools. Caso tenha dificuldade em localizá-las los, entre em contato com o suporte técnico.
Variável | Significado | Onde encontrar |
|---|---|---|
base | A URL base do seu ambiente PrivacyTools. | Menu 'Consentimentos / Api API de integraçãoIntegração'. |
publicKey ou publicAuthorization | Chave pública para utilização de alguns recursos. | Menu 'Consentimentos / Api API de integraçãoIntegração' Aba: “Integre "Integre com seu website”website" |
hashTemplate | Código hash da finalidade específica. | Menu 'Consentimentos / Finalidades', escolha o grupo e depois , em seguida, copie o hash da finalidade. |
hashUser | Hash do identificador do titular do dado pessoal (usuário). | Você deve gerar esse hash. Recomendamos usar um algoritmo MD5 /ou SHA do ID do usuário + algum combinado com um SALT. |
Como obter o hashTemplate?
Quando um titular precisa consentir com alguma determinada uma condição específica em seu site ou sistema, essa condição precisa existir estar registrada na plataforma de gerenciamento da de privacidade. O hashTemplate nada mais é do que um código identificador da dessa condição para , permitindo que você possa acompanhar acompanhe, através de dashboards e auditoria, exatamente qual condição cada usuário concordou ou discordou.
Para obter um hashTemplate, siga o passo a passo abaixo:
Acesse o menu “PrivacidadePrivacidade / Consentimentos / Finalidades”Finalidades.
Escolha (ou crie) um grupo de finalidades e clique no botão “+ Finalidades”Finalidades.
Caso já existam finalidades, o hashTemplate é será apresentado na lista como “Hash Hash do registro”registro.
Caso não exista nenhuma finalidade, clique no botão “Adicionar” Adicionar para criar a sua primeira finalidade
Título | Descreva um título para essa finalidade. Depois você poderá usar esse título em uma janela para pedir consentimento do usuário. | ||
Código | Código identificador para uso interno e controle. | ||
Tipo | Escolha o tipo de finalidade, pode . Pode ser uma finalidade para coleta de dados pessoais ou apenas um pedido de concordância de alguma condição. | ||
Status | Você pode ativar ou desativar finalidades. | ||
Retenção (em dias) | Caso o titular dê o consentimento em uma determinada data, o sistema irá revogar o consentimento após essa quantidade de dias. | ||
Finalidade do consentimento | Explique o motivo que pelo qual você precisa desse consentimento do usuário. | ||
Exigência |
A ferramenta oferece as opções acima para atender os requisitos de negócio e apetite de risco de cada organização. Recomendamos, por boa prática, manter esse campo como “NÃO”. | ||
URL’s |
| ||
Dados pessoais | Você pode listar todos os dados pessoais que são tratados a partir do consentimento do usuário - . Isso serve para demonstrar transparência de uma forma simples, para que o usuário saiba quais dados seus serão envolvidos após ele concordar com a finalidade. | ||
HTML da Popup | O campo “Conteúdo Conteúdo HTML do corpo da popup” popup permite criar um conteúdo adicional no formato HTML para exibir na popup de pedido de consentimento. Você pode colocar links, textos, etc. |
5. Pronto! Basta salvar, basta salvar e você já possui terá uma finalidade cadastrada com um “hashTemplate” hashTemplate gerado, pronto para poder utilizar ser utilizado em suas integrações.
Como gerar um hashUser?
O “hashUser” hashUser serve para você gerar um identificador único (UUID) do titular do dado pessoal, de modo forma que, para a plataforma de gerenciamento da privacidade, ele não tenha nenhum significado, mas para o cliente, ele sirva funcione como um meio de identificar o titular usando meios , utilizando seus próprios métodos.
infoDica
, você pode usar o site
SHA256para testar diferentes algoritmos de hash
e gerar o hashUser ou outros tipos de hash.
Exemplos:
Base de dados do cliente:
ID: 10001
EMAIL: joao@cliente.com.br
CPF: 000.000.000-60
Os três atributos ao lado formam um identificador único do usuário.
A empresa pode criar um “SALT”, ou seja, SALT, que é uma senha complementar usada para dificultar a reversão do hash, tornando o processo de geração do identificador mais seguro.
Exemplo de SALT:
#EMP#@!1388979!@^A
Para gerar o hashUser, você pode utilizar um algoritmo de hash como MD5 ou SHA256. Aqui está um exemplo de como concatenar os atributos do usuário e gerar o hash:
Exemplo:
ID + EMAIL + CPF =
10001joao@cliente.com.br000.000.000-60ID + EMAIL + CPF + SALT
=
10001joao@cliente.com.br000.000.000-60#EMP#@!1388979!@^A
Resultados dos algoritmos de hash:
MD5 =
426a562aa633b781802c9b5be3efeca6SHA256 =
b617a4b252754717b45baddc7f73d9d8cfb589d58b7bc1d5809ea234a5065fc6
No exemplo acima, tanto o MD5 quanto o SHA256 poderiam ser usados como o seu hashUser. Esse exemplo é obviamente Embora esse seja um caso fictício uma vez que você pode usar meios mais simples de geração de , é importante notar que existem métodos mais simples para gerar um ID único. O importante fundamental é garantir que o ID não seja um ID sequencial (como 10001, 10002, 10003) ou muito fácil de inferir facilmente previsível, como um MD5 gerado a partir de números inteiros ou mesmo dados codificados em Base64.
E quando o usuário é anônimo, como gerar o hashUser?
No caso de usuários anônimos, ou seja, você quando não possui se tem conhecimento sobre a sua identidade, recomendamos utilizar como argumentos para geração do Hash um conjunto de atributos da navegação do usuário que possam como base para a geração do hash. Esses atributos devem ser escolhidos de forma a torná-lo único com , garantindo a maior precisão possível.
infoDica
. veja como funciona o
AMIUniquee você pode encontrar excelentes ferramentas aqui
Exemplos de atributos que podem ser usados para gerar um hash único:
JSESSION ID (aplicações java webJava Web)
IP
Cabeçalhos do navegador
Não tenho condições de desenvolver isso, tem algum serviço fácil para gerar o hashUser?
Sim, consulte na a API do Backend o no serviço “"/external_api/consent/generateHashUser” generateHashUser".
Com o esse serviço acima , você envia os dados básicos do titular e ele gera o hashUser para você um hashUser. O serviço não irá armazenar armazena nenhum dado, ele apenas calcula o hash em tempo real o hash e lhe devolve o valor para utilização.
Tipos de erros comuns
| 1 | 404 | Será lançado quando não existir houver nenhum serviço que lhe atenda à sua necessidade. Confira Verifique se o método está correto (GET/POST/DELETE/PUT) está correto e se a URL está correta. |
| 2 | 400 | O erro de BAD REQUEST será lançado retornado quando você enviar valores inválidos forem enviados nos parâmetros. |
| 3 | 403 | O erro de FORBIDDEN será lançado retornado quando você utilizar chaves inválidas forem usadas, chaves de autorização expiradas, ou quando a URL invocadora não tiver permissão, ou ainda em outros casos relacionados a critérios de permissionamento.permissão. |
Ficou com dúvidas? Chame o Time de Suporte 👈