Essa área tem como objetivo descrever cenários de casos de uso comuns na utilização da API de Integração para que sirva de guia para desenvolvedores. Caso você tenha um cenário de uso diferente mande um e-mail para suporte@privacytools.com.br
Aviso importante: A citação do termo “Consentimento” não tem relação direta com a base legal do consentimento prevista pela LGPD mas sim com a ação do usuário, titular do dado pessoal, em concordar ou discordar de eventuais finalidades propostas. A decisão quanto à base legal, embora usada a mesma nomenclatura, faz parte do fluxo de decisão da empresa.
IMPORTANTE: Se você chegou até aqui e não sabe o que significa o “hashUser” e o “hashTemplate”, leia a sessão https://privacyts.atlassian.net/wiki/spaces/GSD/pages/5079309/API+-+Integra+es#Como-obter-o-hashTemplate%3F antes de prosseguir.
Cenário 1 - Coletando consentimentos de usuários (anônimos ou não)
Nesse cenário de integração você precisa coletar e armazenar consentimentos de usuários.
Usuários anônimos ou não: A API trabalha com um $hashUser, ela não se preocupa se esse hash foi gerado para um usuário anônimo ou um usuário identificado, o funcionamento é o mesmo.
Motivação: Através desse recurso a empresa possui a rastreabilidade dos consentimentos e possui meios de comprovação que os consentimentos foram coletados de maneira segura e eficiente.
Como fazer:
Opção 1 | Se você possui um termo de uso no seu site e gostaria de coletar um consentimento através de um botão de “Concordo/Discordo” Veja nos menus “Javascript” e “React” ao lado. |
Opção 2 | Se você quer pedir uma autorização qualquer através de uma popup, veja as opções nos menus “Javascript” e “React” ao lado. No caso da opção do SDK em que você quer construir sua própria popup de pedido de confirmação o serviço retornará um JSON com todos os atributos necessários que você precisa para exibir a popup. |
Opção 3 | Você não quer usar o nosso SDK e gostaria de implementar a sua própria chamada ao serviço para registros de consentimentos anônimos. HTTP GET em $base/public_api/consent/$hashTemplate/$hashUser/$consent $consent = true ou false Pronto! Para saber onde obter as variáveis acima acesse a página “API integrações” ao lado. |
Cenário 2 - Tenho uma base de dados com vários consentimentos já coletados, quero colocar todos eles no sistema para passar a gerencia-los por aí
Nesse caso você precisa fazer uma integração utilizando as API’s privadas de backend, não as API’s públicas de frontend.
Acesse o menu “Conformidade/Consentimentos/API integração” e escolha a aba “Integre com a sua aplicação”
Tome nota das chaves de integração
Na mesma tela você possui disponível a API de integração exposta no formato Swagger.IO. Caso queira estudar a documentação fora da plataforma acesse a página “Backend/Swagger” ao lado.
Registre (caso não tenha registrado ainda) a finalidade do consentimento que será importado e copie a chave do consentimento (hashTemplate)
Para fazer a importação de consentimentos utilize o serviço abaixo:
Endpoint: /external_api/consent/import
Method: POST
{
"consentValue": true,
"document": "string",
"email": "string",
"hashUser": "string",
"name": "string",
"phone": "string",
"templateHash": "string"
"portalHash":"string"
"sendEmailPortal":false
}
Returns: $consentHash
hashUser - Você pode enviar um hashUser mesmo para novos titulares
name - Nome do titular
email - Email do titular
document - CPF do titular
phone - Telefone do titular (opcional)
templateHash -Hash da finalidade do consentimento
consentValue - Envie um booleano (true/false) com o resultado do consentimento, se ele é positivo ou negativo.
consentHash - Protocolo/recibo de confirmação do consentimento registrado.
portalHash - Hash do portal da privacidade. Caso você utilize esse módulo e queira que o sistema envie um email para o titular com o link para ele criar a sua senha no portal e ver os seus consentimentos.
sendEmailPortal -Envie ‘true’ para que o sistema envie o email do portal da privacidade
5. Após a chamada da importação acima o sistema irá procurar algum titular com o mesmo hashUser. Caso não encontre ele criará um novo titular com os dados pessoais submetidos e com o hashUser. Ao final do processo ele registrará o resultado do consentimento para a finalidade sugerida.
Cenário 3 - Quero verificar se o usuário já deu consentimento, caso contrário solicitar consentimento
Esse tipo de cenário é útil em casos onde você quer validar se o seu usuário, normalmente logado, já aceitou algum termo específico do seu negócio, e caso negativo, mostrar algum alerta, bloqueio, ou mensagem solicitando a concordância.
Nota importante: Do ponto de vista das regulamentações de privacidade e proteção de dados o “consentimento” (base legal) deve ser livre e inequívoca, não podendo ser exigida do usuário para que o serviço possa ser prestado. Tome cuidado para que não haja interpretação equivocada quanto ao uso da plataforma de consentimento em casos de bloqueio onde a base legal do “legítimo interesse” é a mais adequada. Em caso de dúvidas verifique com o jurídico da empresa.
Passo 1 - Verificar se o usuário já deu o consentimento
O primeiro passo é a verificação se o usuário já fez o consentimento e qual foi a sua resposta. Você pode fazer isso tanto na sua aplicação backend, quanto na sua aplicação frontend.
Verificando via Backend | Verificando via Frontend |
|---|---|
Para fazer a verificação via backend utilize o serviço abaixo. | Para fazer a verificação via frontend você pode utilizar o nosso SDK Javascript ou React.JS ou mesmo invocar o serviço em seu próprio código |
Endpoint: /external_api/consent/check/{templateHash}/{userHash}
Method: GET
Retorno:
Lista em ordem decrescente
de todos os consentimentos desse titular
para essa condição. Considere a primeira
da lista como a mais recente.
Argumentos:
$templateHash -Hash da finalidade do
consentimento que você quer verificar
$userHash - Hash de identificação
do titular a ser verificado
|
Passo 2 - Buscando o consentimento do titular
Agora que você já verificou se o titular consentiu ou não com a sua finalidade, é a hora de ir em busca do consentimento ou tomar outras ações caso você já tenha o consentimento. Esse fluxo de decisão faz parte do negócio do cliente e deve ser desenvolvido na plataforma correta.
Para realizar a coleta do consentimento leia o caso de uso 1 “Cenário 1 - Coletando consentimentos de usuários” nessa página.