Versions Compared

Key

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

...

...

API de Frontend

Caso você não queira usar nosso SDK JavaScript ou React, utilize os endpoints abaixo.

Expand
titleObter todos os consentimentos de um usuário

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

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

Expand
titleVerificar se o usuário tem um consentimento específico

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

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

Expand
titleRegistrar um consentimento para o usuário

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

$consent = true ou false

Expand
titleRegistrar múltiplos consentimentos para um usuário

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

Expand
titleBusca informações de uma finalidade para exibir uma popup pedindo o consentimento

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

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

Retorno:

Code Block
languagejson
{
   "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.
   */
}

API de Backend

Faça a integração de seus sistemas com a API utilizando a chave privada(secret) e pública disponíveis em sua área interna. Cuide os limites de utilização de cada plano.

Warning

Não utilize essa API no seu frontend (javascript, angular, react etc..) pois a chave privada estaria exposta. Essa API é exclusiva para utilização no backend pelo seu servidor de aplicações.

...

Iframe
scrollingyes
srchttps://demo.privacytools.com.br/swagger-ui.html#/external-consent-controller
width100%
frameborderhide
alignleft
titleAPI Backend
alignleft
height1500px