С чего начать

Быстрый старт

Создайте ключ, подтвердите домен и отправьте контрольное письмо запросом, который безопасно повторять.

Перед началом

Создайте рабочее пространство SendHQ и держите панель управления открытой. Новые рабочие пространства получают контролируемый пробный период для интеграции: пока не активна платная подписка, письма можно доставлять только на email аккаунта или на адрес симулятора AWS SES.

1. Создайте API-ключ

Откройте в панели управления раздел API keys, выберите понятное имя, например Production, и скопируйте ключ, когда он будет показан. Храните его в серверном хранилище секретов. SendHQ больше никогда не покажет полное значение.

.env
SENDHQ_API_KEY=re_your_key_here

2. Добавьте домен отправки

Откройте раздел Domains, добавьте домен, которым вы управляете, и опубликуйте полученные записи DKIM, SPF, DMARC и записи подтверждения SES. Пользователи Cloudflare могут разрешить однократную настройку DNS; SendHQ удаляет OAuth-токен после обратного вызова.

Не публикуйте вторую политику SPF.Если SPF-запись уже есть, добавьте include:amazonses.com в существующее значение v=spf1.

3. Дождитесь подтверждения

Используйте панель управления или POST /domains/:id/verify. DNS может проходить состояния pending, checking и propagating, прежде чем SES сообщит, что адрес отправителя verified.

4. Отправьте контрольное письмо

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

Успешный запрос возвращает ID письма в SendHQ, ID сообщения у провайдера и ID цепочки переписки. Сохраните ID SendHQ вместе с событием приложения, которое вызвало отправку письма.

5. Обработайте результаты

Принятый API-запрос — ещё не доставка получателю. Запросите /emails/:id/events или откройте панель управления, чтобы посмотреть события доставки, отказа, жалобы, отклонения, открытия и клика.