Документация API

REST API для уведомлений через Telegram и Max. Подписчики, OTP, рассылки, формы, helpdesk.

Тестирование интеграции

Перед боевым запуском интеграцию стоит проверить. Zapnoty даёт несколько инструментов: тестовые ключи, предпросмотр и dry-run рассылок.

Тестовые ключи zn_test_

У проекта два ключа: боевой zn_live_ и тестовый zn_test_. Запросы с тестовым ключом обрабатываются API-логикой полностью, но для отладки удобно держать в проекте тестовых подписчиков (свой Telegram/Max) и слать только им.

Предпросмотр сообщения

POST /v1/send/preview рендерит сообщение (шаблон, переменные, подпись) и возвращает итоговый текст без отправки. Удобно проверить, как подставятся vars и какой формат применится.

POST /v1/send/preview
{
"subscriber_id": "550e8400-...",
"template": "welcome",
"vars": { "name": "Анна" }
}
→ {
"rendered_text": "Привет, Анна!",
"format": null,
"text_length": 12,
"has_media": false,
"buttons_count": 0,
"entities_count": 0,
"template_key": "welcome"
}

Dry-run рассылки

Параметр dry_run: true в /v1/broadcast не создаёт рассылку — возвращает размер аудитории под фильтрами, оценку списания кредитов и пример отрендеренного сообщения. Так проверяют фильтры (теги, разрешения) перед реальной отправкой.

POST /v1/broadcast
{
"text": "...",
"tags_all": ["vip"],
"dry_run": true
}
→ { "would_send_to": 342, "estimated_credits": 342, "rendered_sample": "..." }

Проверка вебхуков

Чтобы проверить приём событий, временно укажите в webhook-эндпоинте URL тестового приёмника (webhook.site, ngrok на localhost). Подпись X-Zapnoty-Signature считается так же — проверьте валидацию HMAC. Журнал доставок вебхуков виден в кабинете.

Связанные разделы