Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

Esse passo a passo serve para realizar a integração de um formulário de consentimentos aplicado no seu site com a nossa plataforma.

Primeiramente você deve criar um usuário de API na sua plataforma, segue a documentação:

Usuários para API

Após criar um usuário de API, você deve criar o seu formulário que será disponibilizado na sua plataforma.

Você deve criar a Finalidade dentro da plataforma para gerar o hash do registro que será vinculado ao consentimento:

Gerenciando Finalidades

Após essas configurações você pode utilizar a API de integração abaixo:

 

  1. Realize um POST para “https://dpo.privacytools.com.br/external_api/consent/import”

    1. 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"
}

    2. Composição do Json para atualizar cadastro do titular de dados

      {
"updateUserData": true,
"consentValue": true,
"document": "12345678913",
"email": "teste@teste.com",
"name": "teste",
"templateHash": "4a06afc697dca38388ed1c7f8838b41536c307b4e630fbc50d416bb84aff13b"
"userAgent": "teste123" ,
"userIp": "123456789"
}

A diferença esta no "updateUserData", essa variável informa para API se deve ou não realizar a atualização dos dados.

Variáveis e Chaves

Variável

Significado

Onde encontrar

$base
URL base do seu ambiente PrivacyTools
Menu 'Consentimentos/Api de integração'.
consentValue
Se deseja enviar consentimento

 

document
CPF
CPF do titular de dados a ser enviado.
email
E-mail
E-mail do titular de dados a ser enviado.
metadata
Envio de metadados do titular.
É possível enviar os metadados associados ao titular de dados.
Valores:
“name”: Declara o nome do metadado.
“value”: fornece o valor ao metadado.
name
Nome
Nome do titular de dados a ser enviado.
templateHash
Código hash da finalidade específica
Menu 'Consentimentos/Finalidades', escolha o grupo e depois copie o hash da finalidade.
updateUserData
Se deseja atualizar os dados
Valor:
true - para atualizar
false - não atualizar

userAgent

userIp

Informar o IP do user que está coletando o consentimento

 

O userIP e userAgent devem ser informado no corpo da requisição pelo usuário da mesma, são parâmetros não obrigatórios.

Dados que podem ser atualizados ou enviados pela API:

 

{
  "consentDate": "string",
  "consentValue": true,
  "document": "string",
  "email": "string",
  "hashUser": "string",
  "metadata": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "phone": "string",
  "portalHash": "string",
  "sendEmailPortal": true,
  "sendEmailPortalResetPassword": true,
  "templateHash": "string",
  "updateUserData": true
  "userAgent": "string" ,
  "userIp": "string"
}

  • No labels