Envie pela API
Tudo no produto está disponível por uma API REST. Conecte os envios transacionais (confirmações de pedido, redefinições de senha, alertas) ao seu backend uma vez e depois assine webhooks para eventos de entrega e engajamento.
O que você vai precisar
- Um domínio de envio verificado
- Acesso de administrador para criar uma chave de API
- Um backend capaz de fazer requisições HTTPS
Crie uma chave de API
- 1
Abra Configurações → Chaves de API → “Criar”
Emita uma chave com escopo exatamente do que ela precisa (ex.: messages:send), com um limite de taxa e uma allowlist de IP opcional, para que uma chave vazada não possa ser abusada.
- 2
Copie a chave uma única vez
A chave completa (sb_live_<prefix>.<secret>) é exibida apenas na criação. Guarde-a no seu gerenciador de segredos — ela não pode ser recuperada novamente.
Autentique-se
Toda requisição usa um token Bearer. A URL base é https://api.climails.com/v1.
Authorization: Bearer sb_live_<prefix>.<secret>Envie uma mensagem
Faça um POST para /v1/messages com um canal, um destinatário e um template_id (+ variáveis) ou subject/html em texto puro. Passe uma Idempotency-Key para que uma requisição repetida nunca envie duas vezes.
curl https://api.climails.com/v1/messages \
-H "Authorization: Bearer sb_live_<prefix>.<secret>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order-1042" \
-d '{
"channel": "email",
"to": "[email protected]",
"from_email": "[email protected]",
"subject": "Your order is confirmed",
"html": "<p>Hi Ann, your order #1042 is on its way.</p>"
}'Teste no navegador
Abra Configurações → API & Playground para usar o console interativo RapiDoc: cole sua chave em “Authenticate” e execute requisições reais antes de escrever uma linha de código. A mesma referência é pública em /docs, e a especificação OpenAPI bruta está em /openapi.yaml.
Assine webhooks
Registre um webhook (Configurações → Webhooks, ou POST /v1/workspaces/{workspace_id}/webhooks) para receber eventos de entrega (delivered), retorno (bounce), reclamação (complaint), abertura (open) e clique (click), de modo que seu app reaja ao que acontece após o envio.
- Os recursos com escopo de workspace ficam em /v1/workspaces/{workspace_id}/… — obtenha o seu workspace_id em GET /v1/workspaces.
- Verifique a assinatura do webhook usando o segredo exibido quando você o cria.
Perguntas frequentes
Qual a diferença entre envios transacionais e de campanha?
Transacional = uma mensagem para uma pessoa, disparada pelo seu app (POST /v1/messages). As campanhas são envios em massa para listas/segmentos, agendados pelo painel ou pela API de campanhas.
Como funciona a idempotência?
Envie um cabeçalho Idempotency-Key; uma repetição dentro de 24 horas retorna o resultado original em vez de enviar de novo.
Onde encontro o meu workspace_id?
Chame GET /v1/workspaces com a sua chave — ele lista o workspace ao qual a chave pertence.
Comece a enviar em minutos
Crie uma conta gratuita, conecte seu domínio e alcance seu público em todos os canais — sem cartão de crédito.
Plano gratuito para sempre · Sem cartão de crédito · Pronto em minutos