Документация API 1.21
Предыдущая версия API DashaMail. Работает и продолжит работать — все методы вида ?method=категория.метод на месте.
Новые интеграции лучше писать на REST API v2: там адреса ресурсов вместо одного эндпоинта, HTTP-статусы вместо кодов в теле ответа и примеры на четырёх языках. Что изменилось и как перевести существующий код — Переход с API 1.0.
Как обращаться к API #
Все вызовы идут на один адрес, методами GET и POST, кодировка — UTF-8:
https://api.dashamail.com/?method=lists.get&api_key=YOUR_API_KEYОбязательных параметров два:
| Параметр | Описание |
|---|---|
method | Вызываемый метод вида «категория.метод» — например, lists.get. |
api_key | Ключ авторизации из раздела Аккаунт → Интеграции. |
Формат ответа #
Формат задаётся параметром format: JSON (по умолчанию), JSONP или XML. Структура всегда одна:
msg— как прошёл вызов:err_code(0 — без ошибок),textс сообщением иtypeсо значениемmessage,noticeилиerror.data— запрошенные данные, если они есть.
Полный список кодов ошибок — на странице Коды ошибок.
Категории методов #
| Категория | Методов | Что внутри |
|---|---|---|
| Адресные базы | 21 |
Базы, подписчики, дополнительные поля, импорт, отписки и жалобы. |
| Рассылки | 18 |
Создание, отправка и расписание массовых рассылок. |
| Отчёты | 13 |
Открытия, клики, возвраты и сводная статистика по рассылкам. |
| Аккаунт | 1 |
Настройки и состояние аккаунта. |
| Диалоги | 10 |
Переписка с подписчиками — Даша.Диалоги. |
Коллекция запросов #
Все 63 метода собраны в коллекцию для Postman — её же читают Insomnia, Bruno и Hoppscotch. Обязательные параметры заполнены правдоподобными значениями, необязательные лежат выключенными.
В Postman: Import → вкладка Link → адрес файла. Затем в Variables коллекции впишите свой ключ в api_key.
Для актуального REST API v2 есть своя коллекция и описание OpenAPI 3.1.
Библиотеки #
| Язык | Библиотека | Автор |
|---|---|---|
| PHP | php_dashamail | Zhussupov Zhassulan |
| Python | dasha_python | Зубакин Александр |
Написали свою библиотеку или очень хотите, чтобы она появилась — напишите на support@dashamail.ru. Мы всегда рады талантливым разработчикам.
Вопросы #
Метод ведёт себя не так, как здесь написано — пишите на support@dashamail.ru, вам быстро ответят наши разработчики.