Node.js SDK
Пакет @dashamail/node в scope @dashamail. Работает на
встроенных модулях http/https, без axios и
сторонних HTTP-клиентов. Типы TypeScript идут в комплекте.
| Установка | npm install @dashamail/node |
| Требования | Node.js 12+, только встроенные модули |
| Импорт | require('@dashamail/node') |
| Исходники | github.com/DashaMail/dashamail-node |
| Лицензия | MIT |
Пакет опубликован под scope @dashamail, а не как голый
dashamail: это имя на npm занято сторонним неофициальным клиентом.
Быстрый старт #
const DashaMail = require('@dashamail/node');
const dashamail = new DashaMail('YOUR_API_KEY');
const balance = await dashamail.account.balance();
console.log(balance.data.balance);
const created = await dashamail.lists.create('Newsletter');
await dashamail.lists.addMember(created.data.list_id, 'subscriber@example.com', {
merge_1: 'Иван',
});
await dashamail.transactional.send(
'subscriber@example.com',
'sender@yourdomain.com',
'<p>Спасибо за подписку!</p>',
{ subject: 'Добро пожаловать' }
);
Ресурсы #
DashaMail — фасад с одним свойством на каждый раздел API. Все методы
асинхронные (возвращают Promise) и разрешаются в
Response (обёртка вокруг data, перебирается через
for...of) либо отклоняются с ApiException.
| Свойство | Класс | Раздел |
|---|---|---|
.lists | Lists | Адресные базы |
.segments | Segments | Сегменты |
.campaigns | Campaigns | Рассылки, включая A/B-тесты |
.automations | Automations | Автоматизации |
.workflows | Workflows | Сценарии визуального конструктора |
.templates | Templates | Шаблоны |
.reports | Reports | Отчёты, включая результаты A/B |
.transactional | Transactional | Транзакционные письма |
.account | Account | Аккаунт |
.dialogs | Dialogs | Диалоги |
.router | Router | Обработка входящих |
.images | Images | Изображения |
Пагинация #
let start = 0;
for (;;) {
const page = await dashamail.lists.members(listId, { start, limit: 100 });
for (const member of page) {
console.log(member.email);
}
start += page.getLimit();
if (!page.hasMore()) break;
}
Ошибки #
Каждый неуспешный ответ бросает подкласс ApiException, выбранный
по HTTP-статусу. У любого исключения есть .apiCode — тот же код,
что в справочнике ошибок, .httpStatus
и .details.
| HTTP | Класс исключения |
|---|---|
| 401 | AuthenticationException |
| 402 | PaymentRequiredException |
| 403 | AuthorizationException |
| 404 | NotFoundException |
| 409 | ConflictException |
| 413 | PayloadTooLargeException |
| 422 | ValidationException |
| 429 | RateLimitException — есть .getRetryAfter() |
| 5xx | ServerException |
Если ответ вообще не пришёл (обрыв сети, таймаут) — отклонение происходит с
NetworkException, отдельно от ошибок самого API.
Изображения #
// Готовый файл на диске — без ручного base64:
const result = await dashamail.images.optimizeFile('/path/to/banner.png');
// Сырые байты в ответ вместо base64 в JSON:
const binary = await dashamail.images.optimizeFileBinary('/path/to/banner.png');
binary.saveTo('/path/to/banner-optimized.png');
Полная документация — в README репозитория. Вернуться к обзору всех SDK.