Primeiros passos

🏷️ Módulo de Aceite vs. Módulo de Notificação

O mesmo motor e o mesmo contrato de API atendem dois produtos — a diferença está no desenho do template (com ou sem botões de decisão), não no endpoint usado:

🔒 Autenticação

Toda rota (exceto /health) exige dois headers:

X-API-Key e X-API-Secret são fornecidos pela Clicksign durante o onboarding do módulo de Aceite — não há endpoint público de autocadastro de credencial. O mesmo vale para o template_id: o cadastro e a aprovação do template no canal (ex.: Meta Business Manager, para WhatsApp) são feitos junto à Clicksign. Sua empresa ainda não tem o módulo habilitado? Fale com o nosso time comercial.

🚀 Primeiros passos

1. Receba suas credenciais e o template

Durante o onboarding, a Clicksign fornece X-API-Key / X-API-Secret e o template_id do(s) template(s) já aprovados para a sua conta.

2. Crie um aceite

POST /api/v1/acceptances

{
  "execution_id": "exec-abc-123",
  "channel_type": "whatsapp",
  "destination": "+5511999990000",
  "template_id": "tpl-xyz-456",
  "channel_params": {
    "steps": [
      {
        "step_id": "decisao",
        "sequence": 1,
        "type": "template",
        "content": {
          "template": {
            "variables": {
              "body": ["João Silva", "CTR-2024-001"]
            }
          }
        }
      }
    ]
  },
  "webhook_url": "https://meu-sistema.com/callbacks/acceptance",
  "expiration_time": 86400
}

A resposta é imediata (201, status PENDING) — a validação do template e o envio da mensagem ao canal acontecem de forma assíncrona.

Página de referência: Criar Aceite.

3. Acompanhe a evolução de status

O ciclo de vida é PENDING → SENT → DELIVERED → READ → um status final (ACCEPTED/DECLINED/EXPIRED em fluxos com decisão, ou SENT/DELIVERED em fluxos apenas informativos). A sequência de status não é validada — eventos podem chegar fora de ordem, e o serviço já resolve o desfecho corretamente.

4. Receba o recibo final

Quando o aceite atinge um status final, o serviço entrega (com retry exponencial) um recibo completo — a trilha de status — no seu webhook_url.

5. Consulte o histórico quando quiser

GET /api/v1/reports/{id} retorna o registro completo (inclusive fora da janela do webhook). GET /api/v1/reports lista e filtra seus aceites.

Página de referência: Detalhes do Aceite.

6. Ambientes

✅ Checklist de sucesso

• Recebi X-API-Key, X-API-Secret e o template_id da Clicksign?
• Sei se o meu template é Módulo de Aceite (com decisão) ou Módulo de Notificação (apenas notificação)?
• Configurei um webhook_url para receber o recibo final sem depender de polling?
• Sei que o channel_params só leva as variáveis — o texto do template já está cadastrado do lado da Clicksign?

Próximo passo ➡️

• Como funciona — modelo de dados, ciclo de vida do aceite e endpoints.
• Templates e canais — estrutura do template, variáveis e padrões de decisão.
• Webhooks e relatórios — formato do recibo, idempotência e consulta de histórico.
• Collections — acesse a página central de collections dos produtos desta seção.