API consent/import/phone
- Nicole de Marchi Leite
- Luiz Leite
Para consumo do Endpoint você deve criar um usuário de API na sua plataforma, segue a documentação:Usuários para APIarchived
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 cria um titular e seu status de consentimento. O diferencial deste é utilizar apenas telefone, não sendo necessario e-mail como obrigatório.
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/phone”
Exemplo de composição do Json para novos cadastrados de titulares de dados:
{
"consentValue": true,
"name": "teste",
"templateHash": "4a06123456788ed1c7f8838b41536c307b4e630fbc0d46b5b84aff13b"
"phone": "(51) 99999-9999",
"userIp": "123456789" ,
"groupName": "Teste"
}Dados Obrigatórios:
"consentDate": "string",
"consentValue": true,
"name": "string",
"phone":"string",
"templateHash": "string"Variáveis e Chaves
Variável | Significado | Valores ou locais |
|---|---|---|
consentDate | Data do consentimento. | Formatos possíveis:"yyyy-MM-dd’T’HH:mm:ss.SSSZ", "MM/dd/yyyy", "dd/MM/yyyy", "MM/dd/yyyy hh:mm:ss", "dd/MM/yyyy HH:mm", "dd/MM/yyyy HH:mm:ss", “MM/dd/yyyy hh:mm:ss a” |
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 |
Email do titular | Valor fornecido a variar do titular | |
formOrigin | Formulário de origem | - |
groupName | Grupo de titulares que o titular esta vinculado | Criado e gerenciado na plataforma, em “preferencias > grupos de titulares” |
hashUser | Hash identificador 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 |
phone | Telefone do titular | Valor fornecido a variar do titular |
portalHash | Hash do portal que será usado para mandar email ao usuário | Hash obtido no final do link do portal |
sendEmailPortal | Se o sistema deve enviar email para acesso ao portal da privacidade | Valor fornecido a variar do titularValores:true - deve enviarfalse - não deve enviar |
sendEmailPortalResetPassword | Se o sistema deve enviar email de criação ou troca de senha para acesso ao portal da privacidade | Valor fornecido a variar do titularValores:true - deve enviarfalse - não deve enviar |
sendSMS | habilita o envio de SMS para titular (Cadastro do titular deve ter o phone) | Valor fornecido a variar do titularValores:true - habilitafalse - desabilita |
templateHash | Código hash da finalidade específica | Menu: “Finalidades” escolha o grupo e depois copie o hash da finalidade. |
updateUserData | Se o sistema deve atualizar o titular | 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 |
websiteOrigin | Website de origem | Valor fornecido a variar do titular |
sendSMSMessage | Mensagem que vai conter antes do link que o usuário vai receber por sms | Valor fornecido a variar da mensagem |
Dados que podem ser atualizados ou enviados pela API:
{
"consentDate": "string",
"consentValue": true,
"document": "string",
"email": "string",
"formOrigin": "string",
"groupName": "string",
"hashUser": "string",
"metadata": [
{
"name": "string",
"value": "string"
}
],
"name": "string",
"phone": "string",
"portalHash": "string",
"sendEmailPortal": true,
"sendEmailPortalResetPassword": true,
"sendSMS": true,
"sendSMSMessage": "string",
"templateHash": "string",
"updateUserData": true,
"userAgent": "string",
"userIp": "string",
"websiteOrigin": "string"
}
O parâmetro sendSMS precisa ser utilizado em conjunto com portalHash e email, pois o titular deve possuir um portal de privacidade para acessar logado e gerenciar o consentimento.
Não é necessário fornecer algum tipo de consentimento no templateHash para consumir a API. Contudo, para utilizar o envio de SMS e habilitar o auto-login no link enviado por SMS, é obrigatório que a chave do provedor de SMS esteja registrada Integração com API de SMS e que os campos sendSMS, phone, portalHash e email estejam devidamente preenchidos no corpo da API.