Интеграции веб-сервиса: что выяснить до разработки
Список вопросов к источникам данных, владельцам систем, обмену и проверке ошибок перед проектированием интеграции.
Слово «интеграция» скрывает несколько разных задач: получить данные, передать изменение, согласовать статусы и обработать ошибку. До оценки разработки нужно понять, какое действие пользователя зависит от обмена и какая система считается источником истины.
Нарисуйте путь одного значения
Возьмите ключевой объект — заявку, заказ или запись. Укажите, где он появляется, кто может его менять, в какой системе хранится окончательный статус и что увидит пользователь после изменения. Отдельно запишите, какие поля обязательны, насколько свежими должны быть данные и кто отвечает за расхождения.
Проверьте доступность подключения
Запросите документацию интерфейса, тестовый доступ, правила авторизации, ограничения по объёму и контакты владельца системы. Если технических сведений пока нет, оценка подключения остаётся предварительной. Согласуйте, какие данные можно безопасно использовать при тестировании.
Опишите сбой до успешного сценария
Что случится, если ответ задержится, запрос продублируется или одна система примет изменение, а другая нет? Пользователю нужны понятный статус и дальнейшее действие; команде — возможность восстановить причину по журналу событий. Пример многомодульной системы с несколькими рабочими ролями можно посмотреть в кейсе Кеплер ИТ, но конкретные интеграции нового проекта требуют отдельной проверки.
Карточка подключения
- Объект и поля, которые нужны основному пользовательскому действию.
- Система-источник, её владелец и право на тестовый доступ.
- Способ обмена, момент обновления, проверка повторного запроса.
- Статус, который увидит человек при задержке, отказе или конфликте данных.
- Критерий проверки на тестовом контуре.
Составьте такую карточку для каждого обязательного подключения. Необязательные интеграции лучше оценивать отдельно: их сложность не должна скрываться внутри общей стоимости первой версии.
Частые вопросы
Можно ли начать без доступа к продуктивной системе?
Да, если есть согласованный тестовый контур или образцы данных. Подключение к рабочей системе проверяется отдельно.
Почему список API не равен плану интеграции?
Методы обмена не отвечают на вопросы о владельце данных, конфликтных изменениях и действиях пользователя при ошибке.
Посмотрите направление веб-сервисов или обсудите контур данных.