Документация для разработчиков

DashaMail REST API

REST-интерфейс к DashaMail: адресные базы, рассылки, автоматизации, отчёты, транзакционные письма и обработка входящей почты — всё через обычные HTTP-запросы с JSON.

Что это #

API v2 — это REST-фасад над той же логикой, что работает в личном кабинете DashaMail. Каждая сущность адресуется собственным URL, действие задаётся HTTP-методом, результат — JSON.

GET    https://api.dashamail.com/v2/lists          → список адресных баз
POST   https://api.dashamail.com/v2/lists          → создать базу
GET    https://api.dashamail.com/v2/lists/42       → одна база
PUT    https://api.dashamail.com/v2/lists/42       → изменить
DELETE https://api.dashamail.com/v2/lists/42       → удалить

Если вы уже работаете со «старым» API вида ?method=lists.get — набор возможностей и имена параметров те же самые. Отличается только адресация и коды ответов. См. Переход с API 1.0.

Базовый адрес #

https://api.dashamail.com/v2

Только HTTPS. Только UTF-8. Только JSON — параметр format из старого API здесь не поддерживается, XML и JSONP недоступны.

Разделы справочника #

РазделПрефиксДля чего
Адресные базы/listsБазы, подписчики, дополнительные поля, импорт, отписки
Рассылки/campaignsСоздание и отправка массовых рассылок, вложения, папки
Автоматизации/automationsТриггерные письма по событиям подписчика
Шаблоны/templatesHTML-шаблоны писем
Отчёты/reportsСтатистика по рассылке: доставки, открытия, клики, возвраты
Транзакционные письма/transactionalОдиночные письма: чеки, коды, уведомления
Аккаунт/accountБаланс, отправители, домены, webhooks
Обработка входящих/routerПриём входящей почты, маршруты, разбор писем

С чего начать #

  1. Быстрый старт — первый запрос за пять минут.
  2. Аутентификация — где взять ключ и как его передавать.
  3. Формат запросов и ответов — как устроен конверт ответа.
  4. Коды ошибок — что означает каждый код.

DashaMail хранит и защищает ваши данные на территории Российской Федерации

Подробнее...