🧐 Анализ API-документации DashaMail: что нужно перед интеграцией 🧐

На прошлой неделе опубликовала результат анализа документации KudaGoAPI.

В этом посте разбираемся с #DashaMailAPI

✅ Документация
Вводная страница

✅ Вид API
✔ Нигде явно не указан.
✔ HTTPs-запросы.
✔ Все POST или GET - любой вариант сработает
Все POST/GET = HTTP API.
Даже на запросы по созданию данных можно использовать GET. Поэтому API нельзя назвать REST like.

✅ Авторизация и аутентификация
Стандартный способ аутентификации по API-key.
Ключ для авторизации из раздела «Аккаунт» - «Интеграции» (получать через UI).
Подставляется в query-параметры запроса (после ?).

✅ Тестовые доступы
Нет.
Если необходимо тестировать API, то рекомендуется создать второй бесплатный тестовый аккаунт.

✅ Рекомендации по использованию API
Отсутствуют.
Получаем и создаем данные в любом порядке, используем на своё усмотрение.

✅ Ограничения и особенности
Ответ может быть в одном из нескольких форматов.
Для его задания используйте переменную format:
+ JSON (default)
+ JSONP
+ XML
Количество писем, которое может быть отправлено (или кол-во адресатов), ограничивается тарифами.


✅ Общие требования к обработке ошибок
Ссылка на перечень внутренних кодов ошибок errors
Ответы на все запросы при этом HTTP-200 всегда, даже при ошибках.


✅ Список методов для нашей задачи
Для рассылки уведомлений в #CityGA нужны будут методы:
✔ Добавляем адресную базу
✔ Добавляем подписчика в базу
✔ Удаляем подписчика из базы
✔ Создаем рассылку
В ходе исследовательского тестирования и описания интеграционных Use Case возможно потребуется больше методов.


Эта информация, которая получена в результате первичного анализа API-документации DashaMail, поможет далее в исследовательском тестировании API и в постановке интеграционных задач на разработчиков 📝

#ИнтеграцииGA