В статье узнаете:
- что такое API простыми словами;
- когда бизнесу нужна API-интеграция сайта;
- чем API отличается от готового модуля и вебхука;
- какие данные обычно передаются;
- какие вопросы задать до разработки;
- как проверить, что интеграция не сломает продажи.
Короткий ответ
API – это способ, по которому одна система обращается к другой и получает или отправляет данные по заранее описанным правилам. Для бизнеса это не техническая абстракция. Это путь, по которому сайт может передать заявку в CRM, получить остатки из 1С, создать платеж, показать статус доставки или открыть клиенту данные в личном кабинете.
Если говорить совсем просто: API нужен, когда сайт должен "разговаривать" с другой системой без ручного копирования.
Готовый модуль решает типовую задачу. API нужен, когда задача не помещается в типовой сценарий.
Ситуация: сайт стал частью процесса
Сайт часто начинается как витрина: страницы, тексты, формы, контакты. Потом бизнес растет, и витрины становится мало.
Появляются задачи:
- заявка должна сразу попадать в CRM;
- заказ должен уходить в 1С;
- клиент хочет видеть статус доставки;
- менеджер должен получать уведомление в Telegram;
- пользователь оплачивает счет на сайте;
- партнер заходит в личный кабинет и видит свои документы;
- маркетолог хочет связывать рекламу, заявки и продажи.
В этот момент сайт уже не отдельная страница в интернете. Он становится узлом между системами.
Где API нужен бизнесу
CRM и продажи
API помогает передавать заявки, искать дубли, создавать сделки, назначать ответственных и обновлять статусы.
Пример: строительная компания получает заявку на расчет ремонта. Сайт отправляет в CRM город, площадь, тип объекта, бюджет, UTM-метки и комментарий. Сделка сразу попадает в нужную воронку.
1С и учет
API или другие механизмы интеграции помогают обмениваться товарами, остатками, ценами, заказами, документами и статусами.
Пример: оптовая компания показывает дилеру его цены и остатки по складам. Без интеграции менеджеры отправляли бы прайс вручную.
Оплата
Сайт может создавать платеж, получать статус оплаты, показывать результат пользователю и передавать данные в учет.
Пример: образовательный центр принимает оплату за курс. После успешной оплаты заявка переходит в нужный статус, а студент получает письмо с доступом.
Доставка и статусы
API помогает получать стоимость доставки, создавать отправление, показывать трек-номер и обновлять статус.
Пример: интернет-магазин не обещает доставку "примерно", а показывает варианты на основе города, веса и службы доставки.
Личный кабинет
Личный кабинет почти всегда связан с API. Пользователь должен видеть свои заказы, документы, обращения, тариф, баланс или историю.
Пример: B2B-сервис дает клиенту доступ к отчетам. Данные подтягиваются из внутренней системы, а не загружаются менеджером вручную.
Чем API отличается от модуля и вебхука
| Способ | Когда подходит | Ограничение |
|---|---|---|
| Готовый модуль | типовая задача, популярная CMS и сервис | мало гибкости |
| Вебхук | отправить событие из одной системы в другую | чаще однонаправленная логика |
| API | сложный обмен, поиск, обновление, статусы, несколько систем | нужна разработка и тестирование |
API не всегда лучше. Он просто дает больше контроля. Если бизнес-задача простая, модуль может быть разумнее.
Какие данные можно передавать
Чаще всего через API передают:
- заявки;
- контакты;
- сделки;
- товары;
- цены;
- остатки;
- заказы;
- статусы;
- файлы;
- документы;
- оплаты;
- уведомления;
- пользовательские роли;
- данные аналитики.
Перед разработкой нужно не "подключить API", а описать конкретный обмен: откуда данные берутся, куда уходят, в каком виде и что должно произойти после передачи.
Что нужно решить до разработки
Кто инициирует обмен
Иногда сайт отправляет данные сам. Иногда сайт запрашивает данные у внешней системы. Иногда внешняя система присылает событие на сайт.
Это разные сценарии:
- сайт отправляет заявку в CRM;
- сайт получает остаток товара из 1С;
- платежная система сообщает сайту, что оплата прошла;
- CRM сообщает сайту, что статус клиента изменился.
Какие поля обязательны
Если внешняя система требует обязательные поля, сайт должен их собрать или заполнить по правилам. Иначе API вернет ошибку.
Как защищаются данные
API почти всегда работает с токенами, ключами или OAuth. Эти данные нельзя хранить в публичном коде, показывать в браузере или отправлять подрядчикам без контроля доступа.
Что делать при ошибке
API может вернуть ошибку. Сервис может быть недоступен. Лимит запросов может закончиться. Поле может измениться.
Нужно решить:
- где хранить ошибку;
- кто получает уведомление;
- можно ли повторить запрос;
- что видит пользователь;
- сохраняется ли заявка в резерве.
Частые ошибки
Начинать с технологии, а не с сценария
Фраза "нам нужен API" ничего не объясняет. Нужен сценарий: человек отправляет форму, сайт создает сделку, CRM назначает менеджера, статус возвращается в личный кабинет.
Не описывать поля
Без карты полей разработчик будет угадывать. Потом выяснится, что не передается город, тип услуги, UTM-метки или файл.
Не проверять лимиты и права
У внешних сервисов бывают ограничения по запросам, правам доступа и методам API. Это нужно проверить до обещания сроков.
Не логировать ошибки
Если API-запрос не прошел, ошибка должна остаться в журнале. Иначе бизнес узнает о проблеме от клиента.
Делать интеграцию без тестовых данных
Нужны реальные примеры: заявка клиники, заказ производства, платеж учебного центра, кабинет дилера. На пустых тестах проблемы не видно.
Как проверить подрядчика
Попросите объяснить:
- Какие системы участвуют в обмене.
- Какие данные передаются.
- В какую сторону идет обмен.
- Что запускает передачу.
- Какие поля обязательны.
- Как хранятся ключи доступа.
- Что будет при ошибке.
- Где смотреть журнал обмена.
- Какие тестовые сценарии будут пройдены.
Если подрядчик отвечает только "сделаем через API", этого мало. API – способ, а не результат.
Когда стоит заказывать API-интеграцию
API-интеграция нужна, если ручная работа уже мешает:
- заявки теряются;
- менеджеры копируют данные;
- цены и остатки устаревают;
- клиенты спрашивают статусы вручную;
- отчеты собираются в таблицах;
- сайт не связан с оплатой, CRM, 1С или внутренним сервисом.
Разобрать API-интеграцию сайта
Часто задаваемые вопросы
API-интеграция нужна каждому сайту
Нет. Если сайт только рассказывает о компании и собирает простые заявки, API может быть лишним. Он нужен, когда сайт должен обмениваться данными с другими системами.
Можно ли подключить API после запуска сайта
Можно, но иногда это дороже. Если заранее понятно, что будут CRM, 1С, оплата или личный кабинет, лучше заложить это в структуру проекта.
Что такое REST API
REST API – распространенный подход к обмену данными через HTTP-запросы. Для предпринимателя важнее не название подхода, а то, какие данные можно передать и какие ограничения есть у сервиса.
Почему API-интеграции ломаются
Чаще всего из-за изменения полей, прав доступа, токенов, лимитов, ошибок внешнего сервиса или отсутствия логов.
Нужно ли предпринимателю разбираться в API
В коде – нет. В бизнес-сценарии – да. Нужно понимать, какие данные должны двигаться между системами и что считается успешным результатом.
Вывод
API-интеграция сайта нужна там, где сайт участвует в бизнес-процессе: продажах, учете, оплате, доставке, личном кабинете или аналитике.
Начинать стоит с простого описания: какое действие делает пользователь, какие данные уходят, куда они попадают, кто их обрабатывает и что происходит при ошибке.
Источники
- MDN Web Docs: HTTP request methods.
- OpenAPI Initiative: OpenAPI Specification.
- Bitrix24 REST API: Overview of REST API 3.0.
- 1С:Предприятие: REST интерфейс.
