API - consent/import
- Nicole de Marchi Leite
- Luiz Leite
- Bruno Torves
Para consumo do Endpoint você deve criar um usuário de API na sua plataforma, segue a documentação: Usuários de API
Para importar o consentimento você deve criar a Finalidade dentro da plataforma para gerar o hash do registro que será vinculado ao consentimento:Gerenciando Finalidades
O endpoint consent/import é utilizada para inserir um titular de dados na plataforma, junto com seu status de consentimento. É principalmente utilizado para realizar a integração de um formulário de consentimentos aplicado no seu site com a nossa plataforma.
A API também não possui limite de requisição de forma síncrona, sendo suportado pela nossa arquitetura e escalabilidade.
Após essas configurações você pode utilizar a API de integração abaixo:
Realize um POST para “https://dpo.privacytools.com.br/external_api_v2/consent/import”
Exemplo de composição do Json para novos cadastrados de titulares de dados
{
"consentValue": true,
"document": "12345678913",
"email": "teste@teste.com",
"name": "teste",
"templateHash": "4a06afc697dca38388ed1c7f8838b41536c307b4e630fbc0d46b5b84aff13b"
"userAgent": "teste123" ,
"userIp": "123456789" ,
"groupName": "Teste"
}Dados Obrigatórios:
"consentDate": "string",
"consentValue": true,
"name": "string",
"email":"string",
"templateHash": "string"Exemplo de composição do Json para atualizar cadastro do titular de dados:
É necessario utilizar o campo "updateUserData", essa variável informa para API se deve ou não realizar a atualização dos dados.
Valores:
true - para atualizar
false - não atualizar
{
"updateUserData": true,
"consentValue": true,
"document": "12345678913",
"email": "teste@teste.com",
"name": "teste",
"templateHash": "4a06afc697dca38388ed1c7f8838b41536c307b4e630fbc50d416bb84aff13b"
"userAgent": "teste123" ,
"userIp": "123456789" ,
"groupName": "Teste"
}
Variáveis e Chaves
Variável | Significado | Onde encontrar |
|---|---|---|
$base | URL base do seu ambiente PrivacyTools | Menu 'Consentimentos > Api de integração'. |
consentValue | Valor do consentimento deste usuario | Valor fornecido a variar do titularValores:true - Consentimento aceitofalse - Consentimento revogado |
document | CPF | Valor fornecido a variar do titular |
Valor fornecido a variar do titular | ||
metadata | Envio de metadados do titular. | É possível criar dados adicionais não listados por padrão ao titular de dados.Valores necessarios:“name”: Declara o nome do metadado.“value”: fornece o valor ao metadado. |
name | Nome do titular | Valor fornecido a variar do titular |
templateHash | Código hash da finalidade específica | Menu: “Finalidades” escolha o grupo e depois copie o hash da finalidade. |
updateUserData | Se deseja atualizar os dados já cadastrados na plataoforma | Valores:true - para atualizarfalse - não atualizar |
userAgent | O navegador que o titular está utilizando ao interagir com o consentimento. | Valor fornecido a variar do titular |
userIp | Informar o IP do user que está coletando o consentimento | Valor fornecido a variar do titular |
groupName | Grupo de titulares que o titular esta vinculado | Criado e gerenciado na plataforma, em “preferencias > grupos de titulares” |