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

Добро пожаловать в документацию SendSay API.

Здесь вы найдете подробное описание всех методов API, форматов запросов и ответов, а также примеры использования.

Версия API¶

Текущая версия: Betta 0.253 от 2025-11-17

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

1. Аутентификация¶

Для работы с API необходимо пройти аутентификацию. Доступны следующие методы:

Логин и пароль - базовая аутентификация через login
API ключ - через заголовок X-API-Key
JWT токен - JSON Web Token
OpenID - внешняя аутентификация

📖 Подробнее об аутентификации

2. Формат запросов¶

Все запросы к API выполняются в формате JSON:

{
  "action": "member.get",
  "email": "user@example.com"
}

📖 Формат протокола

3. Основные операции¶

Работа с подписчиками¶

Создать/обновить: member.set
Получить данные: member.get
Список подписчиков: member.list
Импорт: member.import

📖 Методы работы с данными

Рассылки¶

Отправить выпуск: issue.send
Создать черновик: issue.draft.set
Отложенный выпуск: issue.later.set
Управление выпусками: issue.running.*

📖 Методы рассылок

Статистика¶

Универсальная статистика: stat.uni
Стоп-лист: stoplist.*
WebHook события: настройка через sys.settings.set

📖 Методы аналитики

Основные разделы¶

🔰 Начало работы¶

Формат протокола - структура запросов и ответов
Аутентификация - методы входа в систему
Методы API - справочник методов
Справочные таблицы - основные структуры данных

📊 Работа с данными¶

Подписчики - управление подписчиками
Группы адресов - сегментирование аудитории
Анкеты - структурированные данные (АВО)
Ключи данных - современный формат хранения (КД)
Методы API - все методы работы с данными
Справочные таблицы - структуры данных

📧 Рассылки¶

Выпуски рассылки - создание и отправка
Черновики - подготовка рассылок
Мультиканальные выпуски - Email, SMS, Push и др.
Методы API - все методы рассылок
Справочные таблицы - каналы и статусы

📈 Аналитика¶

Статистика - сбор и анализ данных
Универсальная статистика - примеры запросов
WebHook и Callback - события системы
Стоп-лист - управление отписками
Методы API - методы статистики
Справочные таблицы - события и типы

⚙️ Настройки¶

Системные настройки - конфигурация аккаунта
Пользователи и права - управление доступом
API ключи - создание ключей доступа
Методы API - методы администрирования
Справочные таблицы - структуры настроек

Полезные ссылки¶

Примеры запросов - готовые примеры использования API
История изменений - список изменений в API
Ближайшие изменения - планируемые обновления
Общие замечания - важная информация

Используйте навигацию сверху для перемещения по основным разделам документации.

Категория	Метод	Описание
Подписчики	`member.set`	Создать/обновить подписчика
	`member.get`	Получить данные подписчика
	`member.list`	Список подписчиков
	`member.import`	Массовый импорт
Рассылки	`issue.send`	Отправить выпуск
	`issue.draft.set`	Создать черновик
	`issue.later.set`	Отложенный выпуск
Статистика	`stat.uni`	Универсальная статистика
	`stoplist.get`	Получить стоп-лист
Система	`sys.settings.get`	Получить настройки
	`sys.user.apikey.create`	Создать API ключ