API para Desenvolvedores

Method: GET
$base/public_api/consent/getConsentsUser/$userHash

Header-name: publicAuthorization
Header-value: $publicKey
(o header-value deve ser a concatenação da palavra ‘publicAuthorization#’ e a sua $publicKey)

No sistema entre em “Privacidade>>Consentimentos>>API de Integração item publicKey

Method: GET
$base/public_api/consent/getConsentsUser/$userHash/$hashTemplate

Header-name: publicAuthorization
Header-value:$publicKey
(o header-value deve ser a concatenação da palavra ‘publicAuthorization#’ e a sua $publicKey)

No sistema entre em “Privacidade>>Consentimentos>>API de Integração item publicKey

Method: GET
$base/public_api/consent/$hashTemplate/$hashUser/$consent

$consent = true ou false

No sistema entre em “Privacidade>>Consentimentos>>Finalidades>>Clicar em + Finalidades

Method: POST
Content-type: application/x-www-form-urlencoded
$base/public_api/consent/multiple/$hashUser

Params:

• $hashTemplate = Array de parâmetros com o nome “encryptedTemplate” (ex: “?encryptedTemplate=X&encryptedTemplate=Y”)

• $consent = Array de parâmetros com o nome “value” (ex: “?value=true&value=false”)

$consent = true ou false

A API múltipla possui ainda a possibilidade de receber um argumento chamado “data” com um JSON de dados pessoais.

Enviando Dados Pessoais Junto com o Consentimento BETA

Para enviar um conjunto de dados pessoais junto com o consentimento, você precisa criar um JSON no formato abaixo.

[
  { "name":"Nome do dado", "value":"Valor do dado"},
  ...
]

//Exemplo: Enviando nome, cpf e cidade 
[
  { "name":"name", "value":"Francisco da silva"},
  { "name":"document", "value":"00000000"},
  { "name":"city", "value":"São Paulo"}
]

Uma vez criado o seu objeto JSON, envie como um parâmetro chamado “data” no POST do serviço.

Você utilizará esse método quando quiser desenvolver a sua própria popup pedindo consentimento.

Method: GET
$base/public_api/consent/request/$hashTemplate

Retorno:

{
   "hash":"$hashTemplate",
   "title":"Título da finalidade", 
   "reason":"Motivo do consentimento",
   "fields":[
      "dado pessoal 1",
      "dado pessoal n"
   ],
   "urlAccept":"URL de redirect após o usuário aceitar a condição",
   "urlReject":"URL de redirect após o usuário rejeitar a condição",
   "required":"N"

   /* O "required" funciona assim: Se vier 'N' é porque o consentimento é livre 
e por padrão é "não". Se vier 'S' então o consentimento é livre mas o padrão é "Sim".
Já se vier 'R' então não deve ser possível modificar o consentimento, ele não é livre 
sendo apenas informativo.
   */
}