Skip to content
Разработчикам и API

Отправка через API

Всё, что есть в продукте, доступно по REST API. Подключите транзакционные отправки (подтверждения заказов, сброс пароля, уведомления) к своему бэкенду один раз, затем подпишитесь на вебхуки о доставке и вовлечённости.

8 мин чтения

Что понадобится

  • Подтверждённый домен отправки
  • Права администратора для создания API-ключа
  • Бэкенд, способный делать HTTPS-запросы

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

  1. 1

    Откройте Настройки → API-ключи → «Создать»

    Выпустите ключ с минимально нужными правами (например, messages:send), лимитом запросов и опциональным белым списком IP, чтобы утёкший ключ нельзя было использовать.

  2. 2

    Скопируйте ключ сразу

    Полный ключ (sb_live_<prefix>.<secret>) показывается только при создании. Сохраните его в менеджере секретов — повторно его не получить.

Ключи привязаны к одному рабочему пространству. Ключ пространства A не может читать или отправлять для пространства B.

Авторизация

Каждый запрос использует Bearer-токен. Базовый URL — https://api.climails.com/v1.

Заголовок авторизации
Authorization: Bearer sb_live_<prefix>.<secret>

Отправьте сообщение

Отправьте POST на /v1/messages с каналом, получателем и либо template_id (+ variables), либо «сырыми» subject/html. Передайте Idempotency-Key, чтобы повторный запрос никогда не отправил дважды.

Отправка транзакционного письма
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>"
  }'
Рабочее пространство берётся из API-ключа автоматически — для /messages его не нужно указывать в пути.

Попробуйте в браузере

Откройте Настройки → API и Песочница, чтобы воспользоваться интерактивной консолью RapiDoc: вставьте ключ в «Authenticate» и выполняйте реальные запросы до того, как напишете строчку кода. Тот же справочник публично доступен на /docs, а сырая спецификация OpenAPI — на /openapi.yaml.

Подпишитесь на вебхуки

Зарегистрируйте вебхук (Настройки → Вебхуки или POST /v1/workspaces/{workspace_id}/webhooks), чтобы получать события доставки, отскока, жалобы, открытия и клика — и ваше приложение реагировало на то, что происходит после отправки.

  • Ресурсы уровня рабочего пространства живут под /v1/workspaces/{workspace_id}/… — получите свой workspace_id через GET /v1/workspaces.
  • Проверяйте подпись вебхука секретом, который показывается при его создании.

Частые вопросы

Чем транзакционная отправка отличается от рассылки?

Транзакционная = одно сообщение одному человеку по событию в вашем приложении (POST /v1/messages). Рассылки — массовые отправки по спискам/сегментам, запланированные из кабинета или через API рассылок.

Как работает идемпотентность?

Передайте заголовок Idempotency-Key; повтор в течение 24 часов вернёт исходный результат вместо повторной отправки.

Где найти мой workspace_id?

Вызовите GET /v1/workspaces с вашим ключом — он покажет рабочее пространство, которому принадлежит ключ.

Начните отправлять за минуты

Заведите бесплатный аккаунт, подключите домен и охватите аудиторию во всех каналах — карта не нужна.

Бесплатный тариф навсегда · Без карты · Запуск за минуты

Отправка транзакционных сообщений через REST API — Climails