ProdutoAPI
API de assinatura eletrônica aberta e documentada
Envie documentos para assinatura, gere contratos a partir de modelos e acompanhe cada signatário direto do seu sistema. A documentação é pública: sua equipe de tecnologia avalia a integração antes mesmo de criar a conta.
- Documentação pública no padrão OpenAPI 3.1
- Documentos, signatários, modelos, contatos e pastas
- As mesmas evidências da assinatura feita pela tela
O que a API faz
Tudo o que importa na assinatura, pelo seu sistema
Cada operação está descrita na documentação, com os campos aceitos e exemplos de requisição e resposta.
Documentos
Envie o PDF com os signatários, consulte, edite, cancele, reenvie a notificação e veja a situação de cada pessoa.
Documento a partir de modelo
Gere o documento de um modelo preenchendo os campos pela API, ou crie o link para o próprio signatário preencher.
Signatários
Para cada pessoa: papel (assinar, testemunhar, aprovar ou acusar recebimento), canal (e-mail, SMS ou WhatsApp) e autenticação.
Contatos
Cadastre e atualize os signatários da conta e consulte em quais documentos cada um participou.
Pastas
Organize os documentos nas mesmas pastas que a equipe usa na tela e veja quem tem acesso a cada uma.
Usuários e lojas
Liste usuários e lojas para registrar quem criou o documento e em qual unidade da empresa.
Como é uma chamada
A autenticação usa duas chaves, geradas em Configurações › Api dentro da ClickDocs e enviadas como cabeçalho em todas as requisições:
access-token: SEU_ACCESS_TOKEN
secret-access-token: SEU_SECRET_ACCESS_TOKEN
Para mandar um documento para assinatura, o PDF vai em Base64 junto com a lista de signatários. Cada signatário diz como recebe o link e como comprova a identidade:
POST /documentos
{
"documento": {
"nome": "Contrato de prestação de serviços",
"arquivo": "data:application/pdf;base64,JVBERi0xLjcK..."
},
"signatarios": [
{
"nome": "Mariana Souza",
"email": "mariana@exemplo.com.br",
"funcao": "signatario",
"tipo_envio": "whatsapp",
"telefone": "31999990000",
"tipo_autenticacao": "token"
}
]
}
O exemplo é ilustrativo. Os campos obrigatórios, os valores aceitos e as respostas de cada operação estão na documentação da API.
Primeiros passos
Da documentação ao primeiro documento enviado
- GET /documentosAuthorization: token200 OK1
Leia a documentação
Ela é pública: sua equipe confere operações, campos e exemplos antes de começar.
- 022
Crie a conta
Comece pelo teste grátis de 10 dias para integrar com dados de verdade.
- ak_live_••••••••3f9a3
Gere as chaves
Em Configurações › Api, gere o Access Token e o Secret Access Token da empresa.
- POST /documentos{ "signatarios": [...] }201 Created4
Envie o primeiro documento
Faça a chamada e acompanhe a assinatura pela API ou pelo painel da ClickDocs.
Regras da API
Limites claros, sem surpresa em produção
Limite de requisições
Até 3 por segundo e 30.000 por dia, por empresa. Acima disso a resposta é o status 429.
Paginação
Toda listagem é paginada, com até 100 registros por página.
Várias lojas
Empresas com mais de uma loja informam a loja em cada chamada; sem ela, vale a matriz.
Vários usuários
Informe o usuário responsável; sem ele, a API usa o usuário principal da conta.
Mesmas garantias
Pela API ou pela tela, o documento tem as mesmas evidências
Documentos criados pela API seguem o mesmo fluxo de assinatura dos criados pela tela e aparecem para a sua equipe no painel. Signatários, autenticação e histórico funcionam igual.
- Histórico Data e hora, IP, dispositivo e geolocalização
- Integridade Código único do documento e PDF final assinado com o certificado da plataforma
- Conferência Verificação pública pelo código do documento
Dúvidas
Perguntas frequentes sobre a API
Onde fica a documentação da API?+
Em https://app.clickdocs.com/integracao_api/docs, aberta a qualquer pessoa, no padrão OpenAPI 3.1. Lá estão todas as operações, os campos aceitos e exemplos de requisição e resposta.
Como a API é autenticada?+
Com duas chaves da empresa, o Access Token e o Secret Access Token, geradas em Configurações › Api e enviadas como cabeçalho em todas as requisições. Guarde as duas como guardaria uma senha.
Dá para gerar contratos a partir dos meus modelos?+
Sim. A API gera o documento a partir de um modelo com os campos preenchidos pelo seu sistema, ou cria o link para o próprio signatário preencher. Os modelos são criados na tela de modelos.
A API avisa o meu sistema quando o documento é assinado?+
Não há aviso automático para o seu sistema. Para saber se o documento foi assinado, consulte a situação dele, ou a de cada signatário, pela API.
Funciona com qualquer sistema?+
Sim. Qualquer sistema que faça requisições HTTP com as duas chaves consegue se integrar, seja próprio ou de terceiros.
Documentos criados pela API têm a mesma validade dos criados pela tela?+
Sim. Eles seguem o mesmo fluxo de assinatura e guardam as mesmas evidências. Veja o que sustenta a assinatura em validade jurídica.
Posso tirar dúvidas técnicas antes de contratar?+
Pode. Leia a documentação, crie a conta de teste e fale com o nosso time pelo chat se tiver dúvidas sobre o seu projeto.
Integre a assinatura ao seu sistema
Leia a documentação, crie a conta grátis e envie o primeiro documento pela API.