Iubenda logo
Crie Agora

Documentação

Tabela de conteúdos

Consent Solution – introdução e métodos

Os registros de consentimento são uma parte vital da conformidade com a privacidade em geral, mas são especificamente necessários sob o GDPR. Esses registros devem incluir uma forma de identificar o usuário, comprovante de consentimento, registro da ação de consentimento e os documentos legais disponíveis ao usuário no momento do consentimento, entre outras coisas. Você pode ler sobre todos os requisitos aqui.

A Consent Solution fornece uma API para:

  • Adicionar, remover, gerenciar consentimento de usuários
  • Armazenar várias preferências para cada usuário (por exemplo, várias newsletters ou inscrições (opt-ins))
  • Armazenar caso um usuário foi verificado com a dupla inscrição
  • Armazenar informações adicionais sobre o usuário, permitindo que você o identifique no futuro
  • Para cada consentimento, acompanhe o aviso legal ou de privacidade que o usuário aceitou
  • Para cada consentimento, rastreie o formulário/redação apresentado ao usuário
  • Fazer o upload flexível de qualquer prova de consentimento ou aviso legal, incluindo um PDF se o consentimento for coletado em papel
  • Para cada usuário, obtenha as últimas preferências e qual ação de consentimento é a prova de consentimento
  • Para cada usuário, obtenha o histórico de consentimento

Maneiras diferentes de acessar a API

Você pode acessar a API via HTTP, ou através de nossa biblioteca JavaScript A biblioteca JavaScript também vem com funcionalidades extras, tais como:

  • A extração dos dados de consentimento automaticamente de um formulário
  • O armazenamento assíncrono via localStorage

Os métodos são os mesmos para todas as interfaces e são explicados abaixo. Cada interface tem suas próprias instruções de integração e recursos específicos, explicados nos respectivos 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 só suporta ações de gravação

Dashboard de consentimento

O dashboard visual estético e fácil de usar permite que você classifique, analise e revise seus registros de consentimento com facilidade.

Você pode encontrar seu Dashboard da Consent Solution ao visitar seu dashboard da conta principal > [Seu site/app], e depois Consent Solution > Consent Solution Dashboard.

Botão da Consent Solution Dashboard

Uma vez coletados, a classificação e análise dos dados de consentimento do usuário será simples, pois os registros estarão categorizados entre: “Consentimentos”, “Titulares” e “Avisos Legais”:

Consent Solution Dashboard - Consentimento, titulares e avisos legais

Você pode clicar nos ícones do lado direito da tabela para facilitar o acesso a detalhes individuais do usuário, consentimento e avisos legais:

Consent Solution Dashboard - Consentimento, titulares e avisos legais (detalhes)

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

Consent Solution Dashboard - Consentimento, titulares e avisos legais (função de pesquisa)

Você ainda pode aplicar filtros específicos da tabela que você está pesquisando.

Veja um exemplo aqui:

Panorama técnico

A Consent Solution tem o objetivo de permitir que você salve as ações de consentimento realizadas por seus usuários (aqui chamados titulares) e armazene todas as informações necessárias para realizar uma prova de consentimento. Essas ações de consentimento resultam em uma série de valores salvos sobre seus titulares/usuários, que você pode mais tarde lembrar através de um ponto final. Esses valores incluem as preferências do usuário (newsletters, perfilamento, etc) que cada seção de consentimento tenha modificado.

Nomeações

  • Titular: a pessoa a quem os dados pessoais são referidos, o que geralmente coincide com o usuário
  • Consentimento: a ação de providenciar o consentimento. Cada ação de consentimento contém todas as informações necessárias para identificar exclusivamente esse consentimento, o titular que a realizou, as preferências expressas com esse consentimento, os avisos legais que o usuário aceitou, e a prova (por exemplo, a forma com a qual o usuário foi apresentado)
  • Preferências: os vários opt-ins que o usuário concordou, como newsletters, análise de perfil, etc.

Exemplo de implementação

O fluxo de implementação geralmente será assim:

  1. Identifique todas as preferências coletadas dos titulares (e-mail geral, newsletters, e-mail de funcionamento, análise de perfil, etc)
  2. Determine qual identificador exclusivo será enviado à Consent Solution para acessar posteriormente consentimentos e preferências para cada titular. Este campo não é obrigatório, e caso você não forneça um ID do titular, atribuiremos um gerado automaticamente
  3. Identifique todos os pontos onde o titular pode alterar suas preferências, tais como:
    • Na inscrição
    • Ao assinar para a newsletter
    • Ao verificar o duplo opt-in do usuário
    • Nas preferências de página do usuário no seu dashboard
  4. Envie uma chamada de consentimento para cada

A Consent Solution é flexível o suficiente para ser usada nos cenários mais específicos, incluindo cenários offline, como armazenar quaisquer consentimentos que tenham sido coletados no papel.

Métodos e propriedades

Consentimento

Esse método é utilizado para mandar eventos de consentimento. Você pode escrever e ler, mas não pode modificar os eventos de consentimento existentes. Mantenha os consentimentos como um histórico de registros dos consentimentos que o titular forneceu, quer tenham afetado ou não suas preferências.

Propriedades

`timestamp`

Tipo: string (ISO 8601 timestamp)
Valor padrão: preenchido automaticamente caso não for fornecido.
Descrição: O horário em que o consentimento ocorreu.

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

Tipo: hash
Descrição: Embrulho para o conjunto de propriedades subject, que pode ser salvo tanto através do método Titular quanto no método Consentimento. Verifique o método Titular para confirmar as propriedades suportadas neste conjunto.
Observação: subject.id será preenchido automaticamente caso não for fornecido.

legal_notices ([identifier], [version])

Tipo: matriz (aceita vários objetos)
Descrição: matriz dos avisos legais a serem anexados ao evento de consentimento, identificados por identifier e version. Caso version não for fornecido, o mais recente disponível será usado. Aceita os seguintes campos:

  • identifier, string, usado para passar um identificador de seus documentos legais. Aceita nomes semânticos ou valores customizados. Nomes semânticos pré-definidos são:
    • politica_de_privacidade
    • politica_de_cookies
    • termos
  • version, string, usado para especificar a versão dos documentos legais que seu usuário aceitou. Padrão é o mais recente disponível.
proofs ([form], [content])

Tipo: matriz (aceita vários objetos)
Descrição: matriz das provas a serem anexadas ao evento de consentimento. Normalmente é usado para anexar o que o titular foi solicitado (por exemplo, o form) e o que o titular preencheu (por exemplo, content do formulário).
Aceita os seguintes campos:

  • form, string, usado para incluir o formulário
  • content, string, usado para incluir o conteúdo do formulário

Em alguns casos, por exemplo, se você estiver carregando um formulário de papel, o upload de 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 valor-chave com preferências que você está armazenando com a ação de consentimento. Essas preferências também serão atualizadas para o titular e serão recuperadas com o método Titular. É aconselhável definir uma preferência de nome e continuar com ela para todas as suas chamadas. Por exemplo, você pode passar:

  • general: true|false
  • newsletter: true|false
  • profiling: true|false
  • etc.

Titular

Este método permite que você salve informações do assunto e as recupere.

Propriedades que você pode escrever

id

Tipo: string
Valor padrão: auto-preenchido caso não for fornecido
Descrição: Para identificar com exclusividade seus titulares. Será gerado automaticamente caso não for fornecido. É aconselhável enviar um identificador que você já tem em seu banco de dados, ou armazenar o identificador que geramos e, em seguida, fornecer no retorno de chamada, para você poder mais tarde recuperar um titular e atualizar suas preferências ou enviar eventos de consentimento adicionais.

email
first_name
last_name
full_name

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

verified

Tipo: bool
Descrição: Campo reservado e usado para sinalizar se um titular é verificado, por exemplo, através do método de dupla inscrição.

Propriedades apenas para leitura

preferences ()

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

Avisos_legais

Este método permite armazenar os avisos legais que você pode então referenciar sob consentimento → avisos_legais.

Por exemplo, você tem os seguintes avisos legais:

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

Na primeira configuração e sempre que você atualizá-los, você pode usar este método para atualizar a versão. Se você usar a iubenda para seus documentos legais, atualizaremos automaticamente o conteúdo deste método para você sempre que seus documentos legais forem alterados.
Você pode ler como habilitar essa funcionalidade aqui.

Cada vez que um aviso_legal novo ou existente for preenchido, aumentaremos o campo versionpor 1, a partir de 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 seguintes campos:

  • identifier, string, usado para passar um identificador de seus documentos legais. Aceita nomes semânticos ou valores customizados. Nomes semânticos pré-definidos são:
    • politica_de_privacidade
    • politica_de_cookies
    • termos
  • content, string ou hash, o texto legal que você solicitará ao usuário. Você pode armazenar conteúdo em vários idiomas passando um hash com a seguinte estrutura { [language_code]: [content], ... }
  • timestamp, data, gerada automaticamente, mas pode ser substituída, deve ser personalizada com o tempo de atualização do aviso legal. Por padrão, ele é preenchido com o tempo em que a chamada foi realizada
  • version, número, gerado automaticamente, não pode ser substituído

Veja também