API de Frontend
...
Expand |
---|
title | Obter todos os consentimentos de um usuário |
---|
|
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 “Conformidade>>Consentimentos>>API “Privacidade>>Consentimentos>>API de Integração item publicKey |
Expand |
---|
title | Verificar se o usuário tem um consentimento específico |
---|
|
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 “Conformidade>>Consentimentos>>API “Privacidade>>Consentimentos>>API de Integração item publicKey |
Expand |
---|
title | Registrar um consentimento para o usuário |
---|
|
Method: GET $base/public_api/consent/$hashTemplate/$hashUser/$consent $consent = true ou false No sistema entre em “Conformidade>>Consentimentos>>Finalidades>>Clicar “Privacidade>>Consentimentos>>Finalidades>>Clicar em + Finalidades |
Expand |
---|
title | 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 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 Para enviar um conjunto de dados pessoais junto com o consentimento, você precisa criar um JSON no formato abaixo. Code Block |
---|
[
{ "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. |
Expand |
---|
title | 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: Code Block |
---|
| {
"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.
*/
} |
|
...
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. |
...
Note |
---|
Caso encontre problemas no firewall, incluir nas chamadas o header “User-Agent” com a sugestão “Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36” |
Iframe |
---|
scrolling | yes |
---|
src | https://demo.privacytools.com.br/swagger-ui.html#/external-consent-controller |
---|
width | 100% |
---|
frameborder | hide |
---|
title | API Backend |
---|
align | left |
---|
height | 1500px |
---|
|