1.1. Visão geral da documentação

Mapa do portal, com as duas portas de integração

O portal cobre a API v3, o ClickFlow e os módulos, nessa ordem. Esta página é o mapa. O tutorial de cada produto fica na porta correspondente.

⚡

Quer facilitar a integração?

Em vez de montar cada request do zero, baixe as collections prontas para Postman, Insomnia e Bruno. Elas já trazem endpoints, exemplos e variáveis de ambiente para a API v3, o ClickFlow e os módulos. Baixar as collections

Integrando com auxílio de IA?

Disponibilizamos a documentação otimizada para ChatGPT, Claude, Cursor e outros agentes. Conhecer os recursos disponíveis.

Assinatura digital

API do Envelope, webhooks, widget, assinatura presencial, aceite via WhatsApp e migração da API 1.9.

Entrar

Para além do sign

ClickFlow, com Orquestrador, Executor, o Módulo de Coleta de Dados (ClickForm) e os Módulos de Aceite e de Notificação.

Entrar

Como a documentação está organizada

  1. Introdução. Esta página. Em seguida: collections e ferramentas (API v3, depois ClickFlow, depois os módulos), informações gerais, integração com auxílio de IA e SSO via SAML, que é o login com o provedor de identidade da sua empresa.

  2. Assinatura digital. Introdução à assinatura digital: conceitos e glossário do Envelope, primeiros passos e o tutorial com cURL. Enviar para assinatura: Envelope, requisitos, modelos, assinatura posicionada, assinatura automática e observadores. Webhooks. Outras experiências: widget, assinatura presencial e aceite via WhatsApp. Migração da API 1.9.

  3. Para além do sign. Introdução ao ClickFlow, com os primeiros passos. Depois, Orquestrador, Executor, Módulos e Webhooks. Os módulos publicados são o Módulo de Coleta de Dados (ClickForm) e os Módulos de Aceite e de Notificação. Os webhooks do ClickFlow e dos seus módulos estão em Webhooks do ClickFlow.

Host, autenticação e o tutorial mudam conforme o produto. O que vale para a integração está em Informações gerais e em Access token. O passo a passo de cada porta começa em assinatura, ClickFlow, Módulo de Coleta de Dados (ClickForm) e Módulos de Aceite e de Notificação.




❓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


Did this page help you?