API-интеграция сервисов и систем
Настраиваем одну связку двух систем, чтобы сведения передавались по согласованным правилам, а ошибки обмена были видны команде. Проверяем доступные интерфейсы, определяем формат и направление передачи, тестируем результат и передаём документацию.
Срок первой версии
от 1 неделиСостав, точный срок и стоимость согласуем до начала работ.
01 / Результат
Что входит в одну связку систем
- Две согласованные системы
Проверяем интерфейсы и выбираем операции, необходимые для одной связки.
- Формат и направление обмена
Описываем передаваемые поля, источник сведений и порядок обновления.
- Ошибки и журнал
Определяем поведение при неуспешной передаче и сведения для проверки операции.
- Тестирование и документация
Проверяем согласованный обмен и описываем его работу и условия подключения.
02 / Границы задачи
За рамками базового состава
- Цепочка из нескольких систем
- Подписки и лицензии сторонних сервисов
Для разбора нужны названия систем, документация API, примеры данных и требуемые действия. Доступность методов и права проверяем до оценки; цепочку из нескольких систем разбираем отдельно.
Что связываем через API
Интеграция нужна, когда одна система должна получить результат другой: сайт передаёт обращение, рабочий сервис запрашивает статус или учётный инструмент получает согласованную запись. Сначала описываем конкретные данные и действие, ради которого нужен обмен.
Для связи с 1С есть отдельный состав интеграции с 1С, а подключения каналов продаж к CRM рассматриваются в интеграциях CRM. На этой странице начинаем с одной общей связки двух сервисов.
Что проверяем в интерфейсах систем
Смотрим документацию, способы авторизации, доступные операции и ограничения. Уточняем права на чтение и изменение нужных данных. Наличие API у сервиса не означает, что он поддерживает каждое действие, необходимое вашей команде.
Если нужного интерфейса нет, сначала определяем возможность и отдельный объём его подготовки. Разработка самостоятельного API с новым набором методов требует собственных требований. Её не включаем автоматически в цену одной готовой связки.
Формат данных и правила обновления
Согласуем поля, идентификаторы, типы значений и направление передачи. Определяем, какая система подтверждает актуальное значение и когда запускается обмен. Для двусторонней передачи отдельно описываем правила изменения и конфликтов, если она нужна выбранной связке.
Проверяем преобразование на примерах: пустое значение, изменение записи и повторная передача. Дубли и неполные сведения разбираем по требованиям принимающей системы. Частота обмена зависит от возможностей интерфейсов и условий выбранного процесса.
Как видны ошибки обмена
Описываем неуспешные случаи: недоступный сервис, отказ в доступе или неподходящие данные. Определяем сведения журнала, по которым команда может найти проблемную операцию. Повторную попытку и её условия согласуем с учётом того, можно ли безопасно повторить выбранное действие.
Для платежей статус имеет собственный смысл и должен соответствовать выбранному сценарию провайдера. Такие правила разбираем в составе платежей и биллинга. Общая интеграция не задаёт автоматически коммерческие условия оплаты.
Срок, стоимость и проверка интеграции
Ориентир — от одной недели для согласованной связки с доступными интерфейсами. Точный срок и стоимость зависят от методов, формата, правил ошибок и готовности доступов. Подписки и лицензии сторонних сервисов в стоимость разработки не входят.
При приёмке передаём контрольные данные, проверяем полученный результат и согласованные ошибки. Сверяем поведение при повторе, затем передаём код и документацию по обмену. Подключение дополнительных систем получает отдельную оценку и критерии результата.
Вопросы перед началом
В первую интеграцию можно включить несколько систем?
Базовый состав — одна связка двух систем. Цепочку из нескольких сервисов проектируем и оцениваем отдельно по направлениям обмена и зависимостям.
Что делать, если нужного API нет?
Сначала проверяем доступные способы обмена и возможность подготовки нужного интерфейса. Разработка новых методов имеет отдельный объём и не входит автоматически в одну связку.
Лицензии сервисов входят в разработку?
Подписки и лицензии сторонних сервисов не входят. Их необходимость и условия доступа учитываем при согласовании интеграции.
Следующий шаг
Опишем один обмен между двумя системами
Назовите обе системы, покажите документацию и пример записи. Укажите, что должно передаваться, в каком направлении и какое действие должно произойти у получателя.