❗️

Ativação em alta escala está em desenvolvimento.

Se você quer mais performance, eficiência e economizar recursos, o método de ativação padrão via PATCH pode não ser o mais eficiente.

Para garantir que sua aplicação nunca sofra com timeouts (tempo de espera esgotado) e que sua fila de processamento flua sem interrupções, a API v3 oferece a Ativação Assíncrona.

🔄 Como funciona o Fluxo Assíncrono?

Diferente do fluxo comum, onde você espera a Clicksign processar tudo antes de te dar uma resposta, aqui o processo é dividido:

1. Solicitação: Você envia um POST para o endpoint de ativação dedicada.
2. Confirmação Imediata: A Clicksign responde com 202 Accepted. Isso significa: "Recebi seu pedido e ele é válido. Vou processar agora em segundo plano."
3. Processamento: Nossos servidores realizam a ativação, geram os logs e salvam o novo estado.
4. Notificação Final: Assim que terminamos, avisamos seu sistema através de um Webhook.

📍 O Endpoint de Ativação

Diferente da atualização de rascunho, este endpoint é uma ação de execução.

Documentação Técnica: Confira os detalhes de parâmetros na Referência da API: Ativar Envelope.

Exemplo de Requisição (cURL)

curl --request POST \
  --url [https://app.clicksign.com/api/v3/envelopes/SUA_CHAVE_DO_ENVELOPE/activate](https://app.clicksign.com/api/v3/envelopes/SUA_CHAVE_DO_ENVELOPE/activate) \
  --header 'Accept: application/vnd.api+json' \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Content-Type: application/vnd.api+json'

✅ Entendendo a Resposta 202 Accepted

Ao utilizar este endpoint, você receberá uma resposta com o corpo vazio e o código HTTP 202.

Vantagem: Sua aplicação é liberada em milissegundos. Você não precisa manter uma conexão aberta esperando os processamentos pesados.

Atenção: O status 202 não garante que o envelope foi ativado com sucesso, apenas que a solicitação foi aceita para processamento.

🔔 O papel obrigatório do Webhook

Neste modelo, o seu sistema precisa "ouvir" a Clicksign para saber o resultado final. Certifique-se de que sua URL de Webhook está configurada para receber:

• envelope_activated: O sinal verde. O envelope está ativo e os signatários já podem assinar.
• envelope_activation_failed: Algo deu errado. O corpo do Webhook trará os detalhes para sua correção.

💡 Quando usar este método?

• Sistemas de Missão Crítica: Onde você não pode permitir que sua thread de execução fique "travada" aguardando resposta de terceiros.
• Automação de Lote: Quando você ativa muitos de envelopes de uma só vez ou eles possuem muitos documentos.

Próximos Passos ➡️

Precisa consultar o que aconteceu com um envelope específico após a ativação?

Gerenciamento e Consultas de Envelopes .