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

Create a SendHQ workspace and keep the dashboard open. You can verify a domain and create an API key before paying. Sending requires an active subscription: there is no free allowance, including to your own address. Choose a plan at pricing.

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

Open Domains, add a domain you control, and publish the returned DKIM, SPF, DMARC, and domain verification records. Copy the records into your DNS host and click Verify. On Cloudflare, add them as DNS only (grey cloud). Add the records, then click Verify.

Do not publish a second SPF policy.If SPF already exists, merge SendHQ's SPF include (include:amazonses.com) into the existing v=spf1 value.

3. Aguarde a verificação

Use the dashboard or POST /domains/:id/verify. DNS can move through pending, checking, and propagating before the sending identity is 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.