FAQ: dúvidas gerais

Respostas que valem para qualquer produto. Envelope, esteira e formulário ficam na FAQ de cada um, ligada no final desta página.

Ambientes

1. Qual a diferença entre sandbox e produção?

Sandbox é o ambiente de teste. Produção é o ambiente real. O que isso muda em documento, esteira ou formulário está na FAQ do produto.

2. Por onde começo a integração?

Crie uma conta no sandbox, gere um access token e faça uma chamada autenticada no produto que vai integrar. O passo de cada um está na FAQ do produto.

Acesso

3. O access token é o mesmo para todos os produtos?

Sim, para a API v3, o ClickFlow e o Módulo de Coleta de Dados (ClickForm). O host muda por produto e por ambiente. A tabela está em Informações gerais. Os Módulos de Aceite e de Notificação não usam esse token: a autenticação é X-API-Key e X-API-Secret.

4. Preciso autenticar todas as requisições?

Na API v3, no ClickFlow e no Módulo de Coleta de Dados (ClickForm), sim. O header é Authorization, com o access token, sem prefixo Bearer. Sem o token, a API responde 401. Nos Módulos de Aceite e de Notificação, os headers são X-API-Key e X-API-Secret.

Limite e segurança

5. Existe limite de requisição?

Sim. A plataforma limita a quantidade de requisições. Acima do limite, a resposta é 429. O número de cada ambiente está em Limite de requisições. Como tentar de novo sem estourar o limite outra vez está em Integração resiliente.

6. Quais protocolos de segurança a Clicksign aceita?

HTTPS com TLS 1.2. Requisição em HTTP é redirecionada para HTTPS. As cifras aceitas estão em Segurança.

Exemplos e suporte

7. Onde encontro exemplos de integração?

Em Collections, com Postman, Insomnia e Bruno. O passo a passo de cada produto está na documentação dele.

8. Preciso de suporte. Como entro em contato?

Pelo formulário de suporte. Inclua ambiente, conta, método e path, status, body enviado e body recebido. O atendimento cobre a arquitetura da API e as regras de negócio. Não analisamos código fonte das aplicações.

Outras FAQs

• Assinatura eletrônica: FAQ: dúvidas em assinatura — envelope, signatário e notificação.
• ClickFlow: FAQ: dúvidas em ClickFlow — esteira, etapas, disparo e webhook.
• Módulo de Coleta de Dados (ClickForm): Primeiros passos.
• Módulos de Aceite e de Notificação: Primeiros passos.

Próximo passo ➡️

• Access token — crie a conta de sandbox e gere o token.
• Informações gerais — hosts de sandbox e produção.
• Suporte — o que enviar quando pedir ajuda.