Documentação

Integre com auxílio de IA

Está usando assistentes de código como ChatGPT, Claude, Cursor, GitHub Copilot ou outros agentes para integrar com a Clicksign? Disponibilizamos a documentação em formatos otimizados para que esses agentes consumam o conteúdo com mais precisão e menos ruído visual, evitando que processem código HTML, scripts e elementos de navegação irrelevantes.

Recursos disponíveis

Arquivo llms.txt

Mapa completo da documentação em um único arquivo Markdown. Forneça como contexto inicial ao seu agente para que ele conheça toda a estrutura da API Envelope, Webhooks, Widget Embedded, Aceite via WhatsApp e demais recursos.

Acessar llms.txt

Versão .md de qualquer página

Adicione .md ao final de qualquer URL desta documentação para receber o conteúdo em Markdown puro, sem navegação, scripts ou estilos.

Exemplo: /docs/primeiros-passos → /docs/primeiros-passos.md

Botão Copy Page

No canto superior direito de qualquer página, use o botão Copy Page para copiar o conteúdo em Markdown e colar diretamente no LLM da sua preferência, junto com sua pergunta.


Como usar com seu agente

Fluxo recomendado

  1. Forneça llms.txt como contexto inicial. O agente passa a conhecer o catálogo completo da documentação.
  2. Deixe o agente decidir quais páginas em .md consultar a partir do mapa.
  3. Para dúvidas pontuais durante a integração, use o botão Copy Page diretamente na página relevante e cole o conteúdo no chat com o LLM, junto com sua pergunta.

Para referência específica de endpoint, aponte direto para a página em .md dentro de Referências da API.

Boas práticas

  • Informe ao agente que você está integrando com a API 3.0 Envelope. A API 1.9 é legada e não recebe novas funcionalidades.
  • Sempre teste o código gerado em ambiente sandbox antes de enviar para produção.
  • Valide a assinatura HMAC dos webhooks antes de processar qualquer evento.
  • Para alto volume, oriente o agente a usar a ativação performática assíncrona.

Casos de uso comuns

Integração nova do zero

Cole o llms.txt no início da conversa com o agente. Em seguida, peça para ele guiar você pela criação do primeiro envelope, deixando claro a stack que você usa (Node.js, Java, Python, etc.) e o tipo de integração (REST + Webhooks, Widget Embedded, etc.).

Dúvida em uma página específica

Acesse a página em questão, clique em Copy Page e cole no LLM seguido da sua pergunta. Útil para entender comportamento de campos, regras de negócio e códigos de erro.

Migração da API 1.9 para 3.0

Forneça ao agente o comparativo-tecnico.md junto com um trecho do seu código atual. Peça para identificar o que precisa ser refatorado para o modelo Envelope.

Geração de cliente HTTP

Combine o llms.txt com o link para uma página de referência específica (por exemplo, api-criar-envelope.md) e peça ao agente um cliente tipado na linguagem da sua preferência.


💡

Dica: Ao pedir ao agente para gerar código, mencione explicitamente que se trata da API Clicksign 3.0 Envelope. Isso evita que o assistente recorra a padrões de assinatura eletrônica de outros provedores ou a versões antigas da nossa API que ainda podem estar nos dados de treinamento dele.


❓ Precisa de ajuda? Entre em contato com o Suporte

📚 Respostas rápidas? Visite nosso FAQ

Updated 2 days ago