👀 Практика: анализ API-документации Unisender для email-рассылок. Часть 1 👀
Если вам кажется, что для организации простых задач:
1. Подписать пользователя на email-рассылку в веб-приложении
2. Делать рассылку раз в неделю
не надо прикладывать много усилий, то это не так.
В задаче для #BookingGA есть особенности, которые делают интеграцию в меру сложной.
В этом посте я покажу свой подход к анализу API-документации внешних систем, и соберу все важные данные в одном месте.
✅ Документация
Ссылка на раздел по email
✅ Вид API
✔ HTTPS-запросы (HTTP API)
✔ Все запросы GET, но можно делать и все POST
На заметку про безопасность в API:
✔ Кодировка параметров запроса: UTF-8
✔ Ответы всегда в JSON (книга).
✅ Авторизация и аутентификация
✔ Вид: API-KEY (постоянный ключ
✔ Чтобы получить доступ к API для email-рассылок нужен ключ, который можно скопировать в личном кабинете.
На заметку про безопасность:
✅ Тестовые доступы
Упрощенное получение:
Для будущих экспериментов в Postman, уже можете создавать свой ЛК.
🔗Инструкция
✅ Рекомендации по использованию
Есть общее описание "Принцип использования API" - все запросы вида:
И рекомендуемый сценарий "Порядок вызова методов".
🔗 Документация
✅ Ограничения и особенности
Лимиты по запросам:
общее — 1200 запросов/60 секунд
🔗Подробности
Бывают и другие ограничения, зависит от API.
✅ Общие требования к обработке ошибок
Полный перечень:
🔗Стандартные коды ошибок
Не всегда есть.
✅ Список методов для нашей задачи
Для работы с этой частью надо на базовом уровне понимать будущие алгоритмы работы системы.
Список доступных методов
#ИнтеграцииGA
Если вам кажется, что для организации простых задач:
1. Подписать пользователя на email-рассылку в веб-приложении
2. Делать рассылку раз в неделю
не надо прикладывать много усилий, то это не так.
В задаче для #BookingGA есть особенности, которые делают интеграцию в меру сложной.
В этом посте я покажу свой подход к анализу API-документации внешних систем, и соберу все важные данные в одном месте.
✅ Документация
Ссылка на раздел по email
✅ Вид API
✔ HTTPS-запросы (HTTP API)
✔ Все запросы GET, но можно делать и все POST
На заметку про безопасность в API:
Более того, параметр api_key мы настоятельно рекомендуем передавать через POST, чтобы он не сохранялся в логах прокси-серверов.
✔ Кодировка параметров запроса: UTF-8
✔ Ответы всегда в JSON (книга).
✅ Авторизация и аутентификация
✔ Вид: API-KEY (постоянный ключ
✔ Чтобы получить доступ к API для email-рассылок нужен ключ, который можно скопировать в личном кабинете.
На заметку про безопасность:
Ключ доступа не следует передавать посторонним лицам или делать видимым в коде веб-страниц. Иначе кто-то другой сможет отправлять рассылки от вашего имени.
✅ Тестовые доступы
Упрощенное получение:
Пользоваться API можно бесплатно на любом аккаунте.
Для будущих экспериментов в Postman, уже можете создавать свой ЛК.
🔗Инструкция
✅ Рекомендации по использованию
Есть общее описание "Принцип использования API" - все запросы вида:
https://api.unisender.com/LANG/api/METHOD?format=json&api_key=KEY&arg1=ARG_1&argN=ARG_N
И рекомендуемый сценарий "Порядок вызова методов".
🔗 Документация
✅ Ограничения и особенности
Лимиты по запросам:
общее — 1200 запросов/60 секунд
🔗Подробности
Бывают и другие ограничения, зависит от API.
✅ Общие требования к обработке ошибок
Полный перечень:
🔗Стандартные коды ошибок
Не всегда есть.
✅ Список методов для нашей задачи
Для работы с этой частью надо на базовом уровне понимать будущие алгоритмы работы системы.
Список доступных методов
#ИнтеграцииGA