Primeros pasos

Inicio rápido

Cree una clave, verifique un dominio y envíe un correo controlado con una solicitud segura ante reintentos.

Antes de empezar

Cree un espacio de trabajo de SendHQ y mantenga el panel abierto. Los espacios de trabajo nuevos reciben una prueba de integración controlada: las entregas solo pueden ir al correo de la cuenta o a una dirección del simulador de AWS SES hasta que haya una suscripción de pago activa.

1. Crear una clave de API

Abra API keys en el panel, elija un nombre descriptivo como Production y copie la clave cuando se muestre. Guárdela en un gestor de secretos del lado del servidor. SendHQ nunca vuelve a mostrar el valor completo.

.env

SENDHQ_API_KEY=re_your_key_here

2. Agregar un dominio de envío

Abra Domains, agregue un dominio que controle y publique los registros DKIM, SPF, DMARC y de verificación de SES que se devuelven. Los usuarios de Cloudflare pueden autorizar una configuración DNS única; SendHQ descarta el token OAuth después del callback.

No publique una segunda política SPF.Si ya existe un SPF, combine include:amazonses.com con el valor v=spf1 existente.

3. Esperar la verificación

Use el panel o POST /domains/:id/verify. El DNS puede pasar por pending, checking y propagating antes de que SES informe de que la identidad está verified.

4. Enviar un mensaje controlado

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."}'

Una solicitud correcta devuelve un ID de correo de SendHQ, el ID de mensaje del proveedor y el ID del hilo de la conversación. Guarde el ID de SendHQ junto con el evento de la aplicación que originó el correo.

5. Gestionar los resultados

Una solicitud aceptada por la API no equivale a la entrega al destinatario. Consulte /emails/:id/events o use el panel para inspeccionar los eventos de entrega, rebote, queja, rechazo, apertura y clic.