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

Прежде чем проектировать интеграцию, нужно разобраться, возможна ли она вообще.

Для этого мы, как системные аналитики, должны проанализировать API-документацию и найти ключевые разделы, которые помогут ответить на этот вопрос.

Разбираемся на примере #KudaGoAPI, как анализировать API-документацию.

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

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

✅ Авторизация и аутентификация
Не требуется.
Этот раздел отсутствует.
Это публичный API без ограничений на использование.

✅ Тестовые доступы
Не нужны, так как это публичный API на чтение и никаких данных для авторизации к API тоже нет.

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

✅ Ограничения и особенности
Даже если на сервере KudaGo есть ограничение на количество запросов с одного ip-адреса, что очень даже вероятно, то его не указали в документации :)

✅ Общие требования к обработке ошибок
Нет. Описаны на уровне отдельных запросов.
Например, для списка городов.


✅ Список методов для нашей задачи
На этом этапе важно понимать логику будущего алгоритма работы системы.

Сначала продумываю интеграционные Use Cases, не зная деталей внешнего API. А потом подбираю нужные методы.

Для нашей задачи с #CityGA нужны будут методы, связанные с получением мероприятий и событий в городах:
✔ Список городов - их id используются в остальных методах
✔ Список событий
✔ Список мест, куда сходить
✔ Список показов для фильмов в кино

Эти методы мы будем использовать для информирования пользователей о событиях в городе по их личным предпочтениям.

Это простая API-документация для анализа. И у нас ещё есть более интересная интеграция с системой email рассылок DashaMail, которую мы также проанализируем 🤝

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