Iubenda logo
Comece a gerar

Documentação

Índice

Serviço Consent Database – Introdução e métodos

A conservação de registos de consentimento completos é um elemento essencial do cumprimento da privacidade em geral, sendo estes especificamente exigidos nos termos do RGPD. Estes registos devem prever uma forma de identificar o utilizador, a prova do consentimento, o registo da ação de consentimento, bem como os documentos jurídicos à disposição do utilizador no momento do consentimento, entre outros. Saiba mais sobre os requisitos completos aqui.

O serviço Consent Database proporciona-lhe uma API para:

  • Adicionar, revogar, gerir o consentimento do utilizador
  • Registar múltiplas preferências para cada utilizador (por exemplo, se tiver múltiplas newsletters ou aceitações)
  • Registar se um utilizador foi verificado com dupla aceitação
  • Guarde informação adicional sobre o utilizador, permitindo-lhe identificá-lo no futuro
  • Rastreie o aviso legal ou de privacidade que o utilizador aceitou para cada consentimento
  • Rastreie o formato/redação apresentado ao utilizador para cada consentimento
  • Carregue facilmente qualquer formulário de prova de consentimento ou aviso legal, incluindo um PDF se o consentimento tiver sido recolhido em papel
  • Obtenha as preferências mais recentes e a ação de consentimento que constitui a prova de consentimento para cada utilizador
  • Obtenha o histórico de consentimentos para cada utilizador

 

Diferentes formas de aceder à API

Pode aceder à API via HTTP ou através da nossa biblioteca JavaScript. A biblioteca JavaScript inclui ainda algumas funcionalidades adicionais, como por exemplo:

  • Extração automática dos dados de consentimento a partir de um formulário
  • Gravação assíncrona através de armazenamento local

Os métodos são os mesmos para todas as interfaces e são explicados abaixo. Cada interface tem as instruções de integração e funcionalidades específicas, que são explicadas nos respetivos guias:

Principais diferenças

  • A API HTTP deve ser autenticada com a chave privada e a biblioteca JavaScript com a chave pública
  • a API JavaScript suporta apenas ações de escrita, não suportando ações de leitura

Painel de Controlo do Consentimento

O Painel de Controlo visual, estético e de fácil utilização, permite-lhe ordenar, analisar e rever facilmente os seus registos de consentimento.

Pode encontrar o Painel de Controlo do seu serviço Consent Database acedendo simplesmente ao painel de controlo da sua conta principal > [O seu website/aplicação], e de seguida Consent Database > Painel de Controlo da Consent Database

Botão do Painel de Controlo do serviço Consent Database

Depois de recolher os seus consentimentos é muito fácil ordenar e analisar os dados de consentimento dos seus utilizadores, uma vez que os registos são categorizados por “Consentimentos”, “Titulares” e “Avisos Legais”:

Painel de Controlo do serviço Consent Database - Consentimento, Titulares e Avisos Legais

Pode clicar nos ícones do lado direito da tabela para um acesso fácil às informações individuais do utilizador, consentimento e avisos legais:

Painel de Controlo do serviço Consent Database - Consentimento, Titulares e Avisos Legais (informações)

Ou utilizar a poderosa função de pesquisa para encontrar titulares, consentimentos ou avisos legais:

Painel de Controlo do serviço Consent Database - Consentimento, Titulares e Avisos Legais (função de pesquisa)

Pode até aplicar filtros detalhados específicos para a tabela que está a pesquisar.

Veja o painel de controlo em ação aqui:

 

Enquadramento técnico

O serviço Consent Database tem como finalidade permitir-lhe guardar as ações de consentimento realizadas pelos seus utilizadores (aqui denominados titulares) e armazenar todas as informações necessárias para manter como prova. Estas ações de consentimento resultam num conjunto de valores guardados sobre os seus titulares/utilizadores, que mais tarde poderá recuperar através de um ponto final dedicado. Estes valores incluem as preferências do utilizador (newsletters, definição de perfil, etc.) que cada secção de consentimento modificou.

Definições

  • Titular: a pessoa à qual se referem os dados pessoais, que geralmente coincide com o utilizador
  • Consentimento: a ação de prestar o consentimento. Cada ação de consentimento contém todas as informações necessárias para identificar de forma única esse consentimento específico: o titular que a realizou, as preferências manifestadas com tal consentimento, os avisos legais que o utilizador aceitou, a prova (por exemplo, o formulário apresentado ao utilizador)
  • Preferências: as várias aceitações do utilizador, por exemplo, relativamente a newsletters, definição de perfis, etc.

Exemplo do fluxo de implementação

De um modo geral, o fluxo de implementação terá este aspeto:

  1. Identificar todas as preferências que recolhe dos titulares (gerais, envio de emails de newsletters, envio de emails com base no comportamento, definição de perfis, etc.)
  2. Determinar o identificador único a enviar para o serviço Consent Database para, mais tarde, aceder aos consentimentos e preferências de cada titular. Este campo não é obrigatório, e se não fornecer um ID de titular, atribuiremos um gerado automaticamente.
  3. Identificar todos os pontos onde o titular possa alterar as suas preferências, como por exemplo:
    • No momento do registo
    • Ao subscrever uma newsletter
    • Ao verificar o utilizador através de dupla aceitação
    • Na página de preferências,no painel de controlo do utilizador
  4. Enviar um pedido de consentimento para cada um

O serviço Consent Database é suficientemente flexível para ser utilizado nos cenários mais díspares, incluindo cenários offline, como o armazenamento de quaisquer consentimentos que tenham sido recolhidos em papel.

Métodos e propriedades

Consentimento

Este método é utilizado para enviar eventos de consentimento. Pode escrever e ler, mas não pode modificar eventos de consentimento existentes. Guarde os consentimentos como um registo histórico dos consentimentos que o titular tenha prestado, independentemente de terem alterado as suas preferências.

Propriedades

`timestamp`

Tipo: string (timestamp ISO 8601)
Valor pré-definido: automaticamente preenchido se não for fornecido
Descrição: O timestamp em que o consentimento ocorreu

titular ([id], [email], [first_name], [last_name], [full_name], [verified])

Tipo: hash
Descrição: Wrapper para o conjunto de propriedades do titular, que podem ser guardadas através do método do Titular ou a partir do método do Consentimento. Verifique o método do Titular para as propriedades suportadas dentro deste conjunto.
Nota: o id do titular será automaticamente preenchido se não for fornecido.

legal_notices ([identifier], [version])

Tipo: array (aceita vários objetos)
Descrição: array dos avisos legais a associar ao evento de consentimento, identificados pelo seu identificador e versão. Se não for fornecida uma versão, será utilizada a mais recente disponível. Aceita os campos seguintes:

  • identificador, string, utilizados para passar um identificador dos seus documentos jurídicos. Aceita nomes semânticos ou valores personalizados. Os nomes semânticos pré-definidos são:
    • privacy_policy
    • cookie_policy
    • termos
  • versão, string, utilizados para especificar a versão dos documentos jurídicos que o seu utilizador aceitou. A versão pré-definida é a mais recente disponível.
proofs ([form], [content])

Tipo: array (aceita vários objetos)
Descrição: array das provas a associar ao evento de consentimento. É normalmente utilizado para associar o que foi solicitado ao titular (por exemplo, o formulário) e o que o titular preencheu (por exemplo, o conteúdo do formulário).
Aceita os campos seguintes:

  • formulário, string, utilizados para incluir o formulário
  • conteúdo, string, utilizados para incluir o conteúdo do formulário

Em alguns casos, por exemplo, se estiver a carregar um formulário em papel, carregar apenas um dos dois (como o conteúdo) que contém o formulário e o conteúdo, será suficiente.

preferences ({ [preference_name]: [preference_value], ... })

Tipo: hash
Descrição: conjunto de pares de valores-chave com preferências que está a guardar com a ação de consentimento. Estas preferências serão igualmente atualizadas para o titular, podendo ser recuperadas através do método do Titular. É recomendável definir uma nomenclatura de preferências e seguir a mesma em todas as suas chamadas. Por exemplo, pode aprovar:

  • geral: verdadeiro|falso
  • newsletter: verdadeiro|falso
  • definição de perfis: verdadeiro|falso
  • etc.

Titular

Este método permite-lhe guardar informações sobre o titular e recuperá-las.

Propriedades que pode escrever

id

Tipo: string
Valor pré-definido: automaticamente preenchido se não for fornecido
Descrição: Para identificar de forma única os seus titulares. Será gerado automaticamente se não for fornecido. É recomendável enviar um identificador que já possua na sua base de dados ou armazenar o identificador que geramos e depois fornecemos no callback, para que, mais tarde, possa recuperar um titular e atualizar as suas preferências ou enviar outros eventos de consentimento.

email
nome_próprio
apelido
nome_completo

Tipo: string
Descrição: Para a sua conveniência, para poder identificar um titular mais facilmente.

verificado

Tipo: bool
Descrição: Campo reservado utilizado para indicar se um titular foi verificado, por exemplo, através do método de dupla aceitação

Apenas propriedades de leitura

preferences ()

Tipo: hash
Descrição: contém as preferências mais atualizadas que o utilizador forneceu através dos eventos de consentimento. Incluindo o ID de consentimento mais recente para cada preferência.

Avisos_legais

Este método permite-lhe guardar os avisos legais que poderá depois consultar mediante consentimento → avisos_legais.

Por exemplo, tem os seguintes avisos legais:

  • Política de Privacidade
  • Política de Cookies
  • Termos e Condições

Na primeira configuração, e sempre que os atualizar, poderá utilizar este método para atualizar a versão. Se utiliza a iubenda para os seus documentos jurídicos, atualizaremos automaticamente o conteúdo deste método por si sempre que os seus documentos jurídicos sejam alterados.
Saiba mais sobre como ativar esta funcionalidade aqui.

Sempre que um aviso_legal novo ou já existente for preenchido, aumentaremos em 1 o campo da versão, começando em 1.

Propriedades

legal_notices 
    (
        { 
            identifier: [ privacy_policy|cookie_policy|terms|[custom] ], 
            content: [the actual legal text]
            timestamp: [date] // auto-generated, but can be overridden
            version: [1+] // progressive number, auto-generated, cannot be overridden
        }
    )

Aceita os campos seguintes:

  • identificador, string, utilizados para passar um identificador dos seus documentos jurídicos. Aceita nomes semânticos ou valores personalizados. Os nomes semânticos pré-definidos são:
    • privacy_policy
    • cookie_policy
    • termos
  • conteúdo, string ou hash, o próprio texto jurídico que solicitará ao utilizador. Pode guardar conteúdo em vários idiomas ao utilizar um hash com a seguinte estrutura { [language_code]: [content], ... }
  • timestamp, data, gerado automaticamente, mas pode ser anulado, deve ser personalizado com a hora de atualização do aviso legal. Por norma, é preenchido com a hora em que o pedido é efetuado
  • versão, número, gerado automaticamente, não pode ser anulada

Veja ainda