Conceitos Fundamentais

A classe base (base_default) gerencia as propriedades comuns para Signer e MultiSigner, como api_key, mode e agreed (que indica se os termos foram marcados).

Aceite Simples (Classe Signer)

Use a classe Signer quando o seu fluxo exigir o aceite de um único documento. Ela gerencia uma transação de aceite individual do início ao fim. Você define o participante (set) e o conteúdo que ele deve aceitar (content). Ao final, o método agree formaliza exclusivamente aquele aceite.

Cenário Ideal: Um novo usuário se cadastrando e precisando aceitar a Política de Privacidade.

Métodos principais

• contents: Adiciona o conteúdo que receberá o aceite. (Tipo de documentos aceitos: PDF)
• set: Define o participante que dará o aceite.
• agree(): Inicia o processo de formalização do aceite. Retorna uma Promise com o conteúdo e a prova do aceite. A lista contents não pode estar vazia e o signer (participante) deve ter sido definido.

Aceite Múltiplo (Classe MultiSigner)

Projetada para coletar o aceite de vários conteúdos. Use a classe MultiSigner quando um usuário precisar dar o aceite em vários documentos diferentes de uma só vez, de forma otimizada. O propósito desta classe é criar um "pacote" de aceites. Em vez de realizar várias chamadas separadas para cada documento, você adiciona todos os itens ao MultiSigner e formaliza tudo com uma única chamada ao método agree(). Cada item adicionado representa um aceite individual que será agrupado nesta transação em lote.

Cenário Ideal: O paciente em um hospital precisa concordar com vários termos, autorização de imagem e LGPD por exemplo. Ele visualiza a lista de termos para consentimento e com um único aceite, aprova todos simultaneamente.

Métodos principais

• contents: Adiciona um conteúdo à lista de conteúdo que receberam os aceites. Aqui o conteúdo já deve ter sido criado utilizando o método Signer()
• set: Define o participante que dará o aceite.
• agree(): Formaliza o aceite para todos os conteúdos da lista em uma única operação. Retorna uma Promise. Pré-requisitos: A Lista contents não pode estar vazia.

Casos de uso e exemplos

A biblioteca pode ser usada para orquestrar fluxos de trabalho que dependem de consentimento.

Cenário 1: Usuário aceita Termos de Serviço (usando Signer) Um novo usuário pode usar a classe Signer para formalizar seu aceite aos termos de serviço da plataforma.

Cenário 2: O Departamento aprova um lote de políticas (usando MultiSigner) Após uma revisão, um departamento pode usar a classe MultiSigner para formalizar o aceite de múltiplas políticas internas de uma só vez.

Referência da API | Swagger

A interação com a biblioteca resulta em chamadas para uma API REST que pode ser consultada neste link.

Consulte também nosso projeto no Github aqui.

Glossário

Click.Agree: É uma solução de clickwrap projetada para simplificar e formalizar o aceite de um conteúdo digital. Por meio de uma ação explícita do usuário, como clicar em um botão de "Eu aceito", a ferramenta cria uma evidência digital que valida o consentimento.

Clickwrap: O termo refere-se a um tipo de acordo digital que um usuário aceita ao realizar uma ação afirmativa, como marcar uma caixa de seleção ou clicar em um botão com o texto "Eu concordo". É o método utilizado na internet para garantir que os usuários concordem com os termos antes de usar um software, criar uma conta, acessar um serviço entre outros tipos de acordos.

base_default: A classe base que gerencia configurações comuns, como chaves de API, ambientes de operação (desenvolvimento, staging e produção) e os textos de aceite.

Signer: Classe utilizada para formalizar o aceite de um único conteúdo digital por um participante específico. É ideal para cenários diretos como o aceite de Termos de Serviço, onde um usuário concorda com um documento específico.

MultiSigner: Classe projetada para eficiência em escala que permite formalizar o aceite de múltiplos conteúdos, potencialmente por diferentes participantes, em uma única operação. É perfeita para fluxos de aprovação em massa.

Aceite Simples: Cenário de uso da classe Signer que exige o aceite de um único documento. Exemplo: um novo usuário se cadastrando e precisando aceitar a Política de Privacidade.

Aceite Múltiplo: Cenário de uso da classe MultiSigner onde um usuário precisa dar o aceite em vários documentos diferentes de uma só vez.

api_key: Propriedade gerenciada pela classe base que armazena a chave de API para autenticação.

mode: Propriedade que define o ambiente de operação da biblioteca, como "development", "staging" e "production".

agree(): Método principal das classes Signer e MultiSigner que inicia o processo de formalização do aceite. Retorna uma Promise com o resultado da operação.