Обновили документацию DashaMail для разработчиков. Теперь она собрана в одном месте и выглядит одинаково во всех разделах.
А главное — появился REST API v2 с более понятными адресами запросов и подробными примерами.
Что такое REST API v2
API позволяет разработчикам подключать DashaMail к другим сервисам и автоматизировать работу с рассылками, базами и другими функциями.
В новой версии мы сделали адреса запросов понятнее.
Например, раньше запрос для получения списка баз выглядел так: ?method=lists.get
Теперь используется обычный: GET https://api.dashamail.com/v2/lists
Для создания базы: POST https://api.dashamail.com/v2/lists
Для удаления конкретной базы: DELETE https://api.dashamail.com/v2/lists/42
Результат запроса теперь также проще понять. Вместо отдельного кода ошибки внутри ответа API использует стандартные HTTP-статусы.
Сейчас в документации описано 73 методов.
При этом переходить на новую версию сразу не обязательно. Старое API продолжит работать, и отключать его мы не планируем.
Примеры кода прямо на странице
Чтобы разработчику не пришлось самостоятельно писать запрос с нуля, у каждого метода есть готовые примеры на четырёх языках:
- cURL;
- PHP;
- Python;
- Node.js.
Выбираете нужный язык — и документация запомнит выбор. Если работаете на Python, один раз переключились на него, и дальше примеры будут показываться в этом формате. Также у каждого примера предусмотрена кнопка «Копировать».
В описании метода отдельно указаны параметры: какие обязательные, какие необязательные и какие ошибки возникают.
А блок с примером запроса остаётся на экране при прокрутке длинной страницы — не придётся постоянно возвращаться наверх.
Документация не отстаёт от API
Мы внедрили автоматизированную систему обновления документации, которая обеспечивает её полную синхронизацию с реальным функционалом API.
Как это работает:
- все страницы документации формируются автоматически на основе технического описания API;
- система постоянно проверяет соответствие документации реальному функционалу;
- при добавлении новых функций в API происходит автоматическая проверка их описания в документации;
- если какой-либо новый метод не будет своевременно документирован, система автоматически приостановит обновление.
Благодаря этому вы всегда получаете актуальную и полную информацию о возможностях API без задержек и расхождений между реальным функционалом и его описанием.
Все API теперь в одном месте
Раньше документация была разбросана по разным страницам в разном стиле. Теперь у разделов единая навигация и оформление.
В одном месте вы найдёте:
- REST API v2;
- транзакционное API;
- отправку через SMTP;
- Даша.Роутер — обработку входящих писем;
- старое API 1.21.
Между разделами можно переключаться через меню в шапке. Оно остаётся на экране даже при прокрутке страницы.
Ссылку на документацию также добавили в футер сайта, в раздел «Полезное».
REST API v2 и обновлённая документация уже доступны. Если вы работаете с API DashaMail, загляните в новый раздел.
>>> Открыть документацию DashaMail
Регистрируйтесь в DashaMail и оцените новый интерфейс сервиса уже сегодня. Бесплатный тариф позволяет отправлять до 2 000 писем для базы до 100 контактов, чтобы протестировать все ключевые функции платформы.
Loading...