Aprenda os conceitos essenciais para integrar com a API do Envelope da Clicksign.

⚠️

Importante: O envelope está ativo para contas criadas a partir de 01/07/2024. Caso receba o erro de serviço indisponível, entre em contato com [email protected]

O que é a API do Envelope?

A API do Envelope é a nova forma de integrar com a Clicksign. Um envelope é um container que agrupa documentos e signatários em uma única transação, oferecendo mais flexibilidade e controle sobre o processo de assinatura. Com ele, você pode definir exatamente quem assina o quê e configurar a ordem de assinatura

Glossário de Termos Essenciais

Entenda os principais conceitos da API do Envelope.

Envelope

Container que grupa documentos, signatários e requisitos em uma única entidade, representando uma transação completa, e facilitando a gestão dos documentos que são enviados juntos.

Signatário (Signer)

Pessoa que assina o documento. Os signatários são adicionados ao Envelope e conectados aos documentos por meio de Requirements. É possível enviar vários documentos de uma vez para diferentes signatários, e definir quem assina o quê, ou quem apenas observa.

Documento (Document)

Arquivo que será assinado, adicionado ao Envelope. Na nossa arquitetura, documentos são simples - não carregam lógica de signatários ou configurações. Isso fica no Envelope e nos Requirements.

Requisito (Requirement)

Um Requirement conecta um signatário a um documento. Existem dois requisitos obrigatórios: Qualificação (define em qual papel o signatário assina; ex.: Contratante) e Autenticação (define qual método de autenticação será utilizado; ex.: Biometria facial).

Evidência (Evidence)

Representação das "provas" criadas pelos signatários para cumprir os Requirements. Cada Evidence tem um tipo específico e artefatos associados (imagens, textos, etc.).

Notificação (Notification)

Disparo das notificações para os signatários, permitindo que você os informe sobre a necessidade de assinatura dos documentos enviados.

Escolha seu caminho de aprendizado

Primeiros Passos

Novo na API do Envelope? Comece aqui para criar sua primeira integração e entender o fluxo básico.

Começar integração

Migração da API 1.9

Já usa a API anterior? Aprenda as diferenças e como migrar sua integração existente.

Começar migração

Configurações Avançadas

Explore recursos avançados como autenticações, webhooks e integrações complexas.

Ver recursos avançados

FAQ

Tenho uma dúvida específica ou problema pontual que preciso resolver rapidamente.

Buscar respostas

Como a API está organizada?

A documentação da API do Envelope está dividida em seções principais para facilitar sua navegação e aprendizado. Cada seção foca em um aspecto específico da integração.

1. ENVELOPE: É a forma de realizar a integração back end com sua aplicação. É através da API REST que se dá, por exemplo, a criação de documentos, adição e remoção de signatários e finalização de documentos.

2. ACEITE VIA WHATSAPP: É a funcionalidade que permite aceitar termos ou acordos diretamente por meio do WhatsApp através da integração com a API Clicksign.

3. WEBHOOKS: São notificações dos eventos ocorridos na Clicksign para sua aplicação. Quando um evento ocorre, a Clicksign notifica a sua aplicação imediatamente, através de uma requisição HTTP POST para uma URL previamente cadastrada.

4. WIDGET EMBEDDED: É a integração front end que permite que assinaturas sejam realizadas dentro da sua aplicação. Ele preserva o fluxo contínuo do usuário em uma contratação por não implicar troca de contexto para o website da Clicksign.

5. SINGLE SIGN ON VIA SAML: É um padrão aberto que permite que provedores de identidade (IdP) passem credenciais de autorização para provedores de serviços (SP). Ele permite que a sua empresa tenha total controle sobre as políticas de segurança dos usuários cadastrados em sua conta Clicksign pois, após ter o SAML configurado, todos os usuários que possuam e-mail corporativo, com domínio igual ao configurado, terão essa forma de login (SSO via SAML) como padrão.