Теперь методы API DashaMail можно протестировать без программирования. Для этого мы добавили готовые коллекции запросов, которые можно открыть в Postman, Insomnia, Bruno, Hoppscotch или Yaak и выполнять методы прямо из интерфейса.
Коллекции формируются непосредственно из документации API — из тех же данных, на основе которых строятся страницы справочника. Поэтому методы и параметры в коллекции синхронизированы с актуальной документацией.
Какие API доступны в коллекциях
Сейчас можно импортировать три коллекции:
- DashaMail REST API v2 — 97 методов;
- DashaMail API 1.21 — 81 метод для интеграций;
- Haskimail API — 58 методов.
Коллекции используют общий формат, поэтому их можно открыть в любом из популярных API-клиентов.
Где найти коллекции
Вся информация собрана в документации DashaMail. В меню слева появился пункт «Коллекция для Postman» в разделе «Начало работы». Ссылка доступна на всех страницах справочника.
>>> Готовая коллекция DashaMail REST API v2
Параметры и ответы уже подготовлены
Коллекция нужна не только для первого знакомства с API. Она позволяет быстрее разбираться с параметрами конкретных методов.
Например, у запроса «Подписчики базы» во вкладке Params уже перечислены необязательные параметры: limit, state, email, segment_id и другие. Они выключены по умолчанию. Если нужен конкретный фильтр, достаточно включить его — искать название параметра в документации отдельно не придётся.
У каждого запроса также есть пример ответа. Можно заранее посмотреть структуру данных, которые вернёт метод.
Описание запросов синхронизировано со справочником: здесь есть назначение метода, параметры тела запроса, коды ошибок и условия их возникновения, а также ссылка на соответствующую страницу документации.
Важно: запросы работают с реальными данными
Коллекция не является симулятором. API-ключ подключает вас к реальному аккаунту, поэтому запросы действительно выполняют свои действия.
POST может создать данные, DELETE — удалить их, а метод отправки рассылки действительно отправит рассылку.
Для экспериментов лучше использовать отдельную тестовую базу. На рабочем аккаунте сначала попробуйте методы, которые только получают информацию и ничего не изменяют.
Для разработчиков: добавили OpenAPI
Если вы работаете с кодом, рядом с коллекцией доступно описание API в формате OpenAPI 3.1:
Его можно использовать с генераторами клиентских библиотек и получить готовый код для нужного языка программирования.
Хотите попробовать API DashaMail, но не готовы сразу писать код? Импортируйте коллекцию в Postman и отправляйте первые запросы через интерфейс. Зарегистрируйтесь в DashaMail, получите API-ключ и протестируйте возможности сервиса на реальном аккаунте.
Loading...