01

Опишите один маршрут

Начните не со списка API, а с конкретного события. Например: посетитель отправил заявку на сайте, менеджер получил её в CRM, статус обработки вернулся в личный кабинет. Для каждого перехода запишите источник, получателя и ожидаемый результат.

Так становится видно, какие поля действительно нужны и где процесс пока зависит от ручного переноса. Необязательно соединять все системы сразу: первый маршрут должен решать отдельную рабочую задачу.

02

Определите владельца данных

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

  • Источник и получатель данных.
  • Состав полей и обязательные значения.
  • Правила обновления и удаления.
  • Ответственный за качество данных.
03

Заложите ошибку и повтор

Получение заявки сайтом и доставка уведомления — разные события. Сначала сохраните обращение, затем передавайте его дальше. Если CRM недоступна, обращение остаётся в очереди с понятным статусом.

Повтор запроса не должен создавать новую заявку. Для этого применяется идентификатор операции: система узнаёт уже выполненное действие и возвращает его результат. Это особенно важно, когда запрос выполнен, но ответ потерялся в сети.

04

Проверьте маршрут до запуска

Проверьте обычный запрос, неверный формат, отказ внешней системы, повтор и восстановление после сбоя. В журнал событий не должны попадать пароли, ключи API и лишние персональные данные.

Результат проектирования — понятная карта обмена: событие, данные, права доступа, таймаут, ошибка, повтор и ответственный. Такая карта помогает и разработке, и дальнейшему сопровождению.