Versions Compared

Version Old Version 3 New Version Current
Changes made by

Luiz Leite

Luiz Leite

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

O endpoint cria um titular e seu status de consentimento. O diferencial deste é utillizar 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”

...

Variáveis e Chaves

Variável

Resposta

SignificadoSignificado

Valores ou locais

consentDatestring

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”
Valor do consentimento deste usuario
Valor fornecido a variar do titular
Valores:
true - Consentimento aceito
false - Consentimento revogado

document

string

CPF
CPF
Valor fornecido a variar do titular

email

string

Email
Email do titular
Valor fornecido a variar do titular

formOrigin

string

Formulário de origem
-

groupName

string

Grupo de titulares que o titular esta vinculado
Criado e gerenciado na plataforma, em “preferencias > grupos de titulares”

hashUser

string

Hash identificador do titular
-

metadata

string

Lista de metadados

name

string

Nome
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

string

Telefone
Telefone do titular
Valor fornecido a variar do titular

portalHash

string

Hash do portal que será usado para mandar email ao usuário
Hash obtido no final do link do portal

sendEmailPortal

string

Se o sistema deve enviar email para acesso ao portal da privacidade

sendEmailPortalResetPassword

string
Valor fornecido a variar do titular
Valores:
true - deve enviar
false - 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 titular
Valores:
true - deve enviar
false - não deve enviar

sendSMS

string

habilita o envio de SMS para titular (Cadastro do titular deve ter o phone)
Valor fornecido a variar do titular
Valores:
true - habilita
false - desabilita

templateHash

string

Hash do consentimento
Código hash da finalidade específica
Menu:“Finalidades” escolha o grupo e depois copie o hash da finalidade.

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
Valores:
true - para atualizar
false - 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

string

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:

...

Info

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.

...