Comece aqui

Início rápido

Crie uma chave, verifique um domínio e envie um e-mail controlado com uma requisição segura para novas tentativas.

Antes de começar

Crie um workspace no SendHQ e mantenha o painel aberto. Novos workspaces recebem um teste de integração controlado: as entregas só podem ir para o e-mail da conta ou para um endereço do simulador do AWS SES até que haja uma assinatura paga ativa.

1. Crie uma chave de API

Abra API keys no painel, escolha um nome descritivo, como Production, e copie a chave quando ela for exibida. Guarde-a em um gerenciador de segredos no servidor. O SendHQ nunca mais retorna o valor completo.

.env
SENDHQ_API_KEY=re_your_key_here

2. Adicione um domínio de envio

Abra Domains, adicione um domínio que você controla e publique os registros de verificação DKIM, SPF, DMARC e SES retornados. Usuários da Cloudflare podem autorizar uma configuração de DNS única; o SendHQ descarta o token OAuth após o callback.

Não publique uma segunda política SPF.Se já existir um SPF, mescle include:amazonses.com ao valor v=spf1 existente.

3. Aguarde a verificação

Use o painel ou POST /domains/:id/verify. O DNS pode passar por pending, checking e propagating antes que o SES informe a identidade como verified.

4. Envie uma mensagem controlada

curl
curl https://sendhq.cc/api/v1/emails \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onboarding-user-42" \
  -d '{"from":"Acme <hello@example.com>","to":["owner@example.com"],"subject":"SendHQ is connected","html":"<h1>It works</h1><p>Your first controlled message was accepted.</p>","text":"It works. Your first controlled message was accepted."}'

Uma requisição bem-sucedida retorna um ID de e-mail do SendHQ, o ID da mensagem no provedor e o ID da thread da conversa. Persista o ID do SendHQ junto com o evento da aplicação que originou o e-mail.

5. Trate os resultados

Uma requisição de API aceita não é o mesmo que a entrega ao destinatário. Consulte /emails/:id/events ou use o painel para inspecionar eventos de entrega, bounce, reclamação, rejeição, abertura e clique.