Блог / Заявки и CRM

Интеграция по API: что подготовить до старта

Коротко. Интеграция по API — это настроенный обмен данными между сайтом и другой системой: CRM, учётной программой, сервисом доставки или оплаты. До старта соберите документацию API, тестовый доступ и описание того, какие данные, куда и как часто должны передаваться. От этих трёх вещей зависят срок и надёжность обмена.

Что такое API простыми словами

API — набор команд, через которые одна программа просит другую что-то сделать: создать сделку, отдать остатки, принять заказ. У каждой системы свой набор команд и свои правила. Их описывают в документации.

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

Что подготовить до старта

Документация API

Ссылку на документацию обычно даёт сама система: у крупных CRM и сервисов она открытая. Если система самописная или отраслевая, документацию запрашивают у её разработчика. Без документации оценить работу честно нельзя — только «по опыту», с риском ошибиться в разы.

Тестовый доступ

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

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

Описание обмена

Достаточно таблицы на одну страницу:

Что передаёмОткуда и кудаКогдаЧто делать при ошибке
заявка с формысайт → CRMсразуповторить, уведомить менеджера
остатки и ценыучётная система → сайтраз в 15 минутоставить старые данные, записать в журнал
статус заказаCRM → сайтпри измененииповторить позже

Такая таблица отвечает на главные вопросы разработчика и превращается в ТЗ на интеграцию.

Как сделать обмен надёжным

Обмен ломается чаще, чем кажется: система обновилась, истёк ключ, сервер не ответил. Поэтому в нормальной интеграции есть:

Как это выглядит на примере заявок — в статье о связке сайта с CRM.

Готовый модуль или своя интеграция

ВариантКогда подходитЧто мешает
готовый модуль или коннекторобмен типовой, системы популярныесложно изменить логику, нет своего журнала
своя интеграциянестандартные поля, несколько систем, важна надёжностьдольше в разработке

Для портала франшизы «ПивМастер» данные сводятся из нескольких источников: факт продаж из 1С УНФ, чеки из программы лояльности KilBil, рейтинги геосервисов. Готового модуля под такую связку нет — подробности в кейсе ПивМастер.

Что проверить при приёмке

  1. Основной сценарий: данные проходят в обе стороны, поля заполняются правильно.
  2. Сбой: отключите доступ на время — после восстановления данные должны дойти.
  3. Повтор: одна и та же заявка, отправленная дважды, не создаёт дубль.
  4. Журнал: по любой записи видно, когда и с каким результатом она ушла.
  5. Документация: где лежат ключи, как их сменить, кому звонить при сбое.

Частые вопросы

Сколько длится интеграция по API?

Зависит от числа систем, объёма данных и качества документации. Типовая передача заявок в CRM — самая быстрая задача. Двусторонний обмен товарами, заказами и статусами занимает заметно дольше.

Что делать, если у системы нет API?

Ищут другие способы: выгрузку файлов по расписанию, обмен через почту или промежуточный сервис. Это менее удобно, но тоже работает. Иногда у системы есть API, просто платное или включается по запросу в поддержку.

Кто платит за доступ к API?

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

Можно ли потом подключить ещё одну систему?

Да, если обмен сразу строили через очередь и журнал. Новая система добавляется как ещё одно направление обмена, без переделки существующих.

С чего начать

Соберите три вещи: ссылку на документацию API, тестовый доступ и таблицу обмена по образцу выше. С ними разработчик назовёт срок без гаданий. Как мы делаем интеграции по API.

Обсудим ваш проект?

Опишите задачу — ответим в течение рабочего дня и подскажем, с чего начать.

Что входит в работу и как она устроена — на странице «Интеграции по API».