2.1. Introdução à assinatura digital
Conceitos da API do Envelope, primeiros passos e glossário
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 nosso Time de Suporte
O que é a API do Envelope?
A API do Envelope é a nova forma de integrar com a Clicksign. Um envelope é um compartimento 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
Compartimento 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 Requisitos. É 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 Requisitos.
Requisito (Requirement)
Um Requisito 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 Requisitos. 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.
Hosts, autenticação e o formato JSON:API da API v3 estão em Ambientes, autenticação e formato. A comparação com o ClickFlow e o Módulo de Coleta de Dados (ClickForm) está em Informações gerais.
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.
Migração da API 1.9
Já usa a API anterior? Aprenda as diferenças e como migrar sua integração existente.
Configurações Avançadas
Explore recursos avançados como autenticações, webhooks e integrações complexas.
FAQ
O passo a passo com cURL está em Veja como funciona na prática.
❓Precisa de ajuda? Entre em contato com o Suporte
💰Dúvida sobre planos e preços? Veja o comparativo
🔍Não sabe qual versão está usando? Descubra a sua versão
📚Respostas rápidas? Visite nosso FAQ
Updated 1 day ago