API de Frontend
Caso você não queira usar nosso SDK JavaScript ou React, utilize os endpoints abaixo.
Obter todos os consentimentos de um usuário
Method: GET
$base/public_api/consent/getConsentsUser/$userHash
Header-name: publicAuthorization
Header-value: publicAuthorization#$publicKey
(o header-value deve ser a concatenação da palavra ‘publicAuthorization#’ e a sua $publicKey)
Verificar se o usuário tem um consentimento específico
Method: GET
$base/public_api/consent/getConsentsUser/$userHash/$hashTemplate
Header-name: publicAuthorization
Header-value: publicAuthorization#$publicKey
(o header-value deve ser a concatenação da palavra ‘publicAuthorization#’ e a sua $publicKey)
Registrar um consentimento para o usuário
Method: GET
$base/public_api/consent/$hashTemplate/$hashUser/$consent
$consent = true ou false
Registrar múltiplos consentimentos para um usuário
Method: POST
Content-type: application/x-www-form-urlencoded
$base/public_api/consent/multiple/$hashUser
Params:
$consent = true ou false
Busca 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:
{
"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.