Para consumo do Endpoint você deve criar um usuário de API na sua plataforma, segue a documentação:Usuários para 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 cria um titular e seu status de consentimento. O diferencial deste é utillizar 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 | Resposta | Significado |
|---|---|---|
consentDate | string | 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 | boolean | Resposta do consentimento “true” / “false” |
document | string | CPF do titular |
string | Email do titular | |
formOrigin | string | Formulário de origem |
groupName | string | Grupo de titulares |
hashUser | string | Hash identificador do titular |
metadata | string | Lista de metadados |
name | string | Nome do titular |
phone | string | Telefone do titular |
portalHash | string | Hash do portal que será usado para mandar email ao usuário |
sendEmailPortal | string | Se o sistema deve enviar email para acesso ao portal da privacidade |
sendEmailPortalResetPassword | string | Se o sistema deve enviar email de criação ou troca de senha para acesso ao portal da privacidade |
sendSMS | string | habilita o envio de SMS para titular (Cadastro do titular deve ter o phone) |
templateHash | string | Hash do consentimento |
updateUserData | boolean | Se o sistema deve atualizar o titular “true” / “false” |
userAgent | string | User-Agent da requisição do Titular para armazenar origin do da requisição original (browser titular) |
userIp | string | Ip da requisição do titular para armazenar ip da origin da requisição original |
websiteOrigin | string | Website de origem |
sendSMSMessage | string | Mensagem que vai conter antes do link que o usuário vai receber por sms |
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.