Интеграция по API — это соединение двух или более программных систем через интерфейс прикладного программирования (API), чтобы они автоматически обменивались данными и запускали действия. Одна система отправляет структурированный запрос, а другая отвечает данными или подтверждает изменение — без ручного экспорта и импорта.
Договор между системами
API — это опубликованный набор правил общения с программой. Он определяет, какие запросы разрешены, какую информацию должен содержать каждый запрос и как будет выглядеть ответ. Поскольку обе стороны следуют одному договору, они могут работать вместе, даже если созданы разными компаниями на разных языках программирования.
Интеграция — это рабочая связь, построенная поверх этого договора. Она определяет, какие данные передаются, в каком направлении, как часто и что происходит при сбое.
Запросы, ответы и события
- Запрос на чтение запрашивает данные, например текущую цену и остаток одного товара.
- Запрос на запись меняет данные, например устанавливает новую цену товара.
- Ответ возвращает результат, обычно в структурированном текстовом формате, таком как JSON, с кодом состояния, показывающим успех или ошибку.
- Webhook разворачивает поток: одна система уведомляет другую в момент события, например нового заказа, а не ждёт запроса.
Большинство API требуют аутентификации — обычно ключа или токена, который идентифицирует вызывающую сторону и ограничивает её действия. Ключи нужно хранить надёжно и давать им только те права, которые нужны интеграции.
Где API встречаются в электронной коммерции
Современные магазины работают на нескольких связанных инструментах. Типичная схема может связывать платформу магазина с платёжным провайдером, службой доставки, бухгалтерской программой, каналом маркетплейса, инструментом рассылок и инструментом ценообразования. Каждая связь — это интеграция, и вместе они поддерживают работу бизнеса без постоянного ручного ввода данных.
Цены — одни из самых чувствительных значений, которые проходят через эти связи. Цена, установленная в одном месте, нередко должна попасть в интернет-магазин, в карточку на маркетплейсе и в фид товаров для товарной рекламы. Если одна из этих копий отстаёт, покупатели видят разные цены в разных местах, а рекламные платформы могут отклонить объявления, у которых цена в фиде не совпадает с посадочной страницей.
Пример процесса обновления цен
Представим для примера магазин аксессуаров для фотоаппаратов, который каждое утро пересматривает цены. В 07:00 инструмент ценообразования рассчитывает новые цены для 120 товаров. Он отправляет запросы на запись через API платформы магазина — по одному на товар или пакетами, если API это позволяет. Магазин отвечает кодами успеха для 118 товаров и ошибками для 2, которых больше нет. Инструмент записывает ошибки в журнал, и сотрудник удаляет старые товары из списка цен.
Без интеграции кому-то пришлось бы вручную копировать 120 цен — медленная работа с реальным риском опечаток. С интеграцией она занимает минуты и оставляет запись о каждом изменении. В BlackAha интеграция с магазином использует такое соединение, чтобы синхронизировать цены с подключённым магазином.
Что выбрать: API, фид или файлы вручную
API — не единственный способ передавать данные. Фиды товаров — файлы, которые публикуются по расписанию, — подходят для больших каталогов, меняющихся несколько раз в день. Импорт таблиц по-прежнему полезен для разовых миграций. API лучше, когда изменения должны быть быстрыми, выборочными или подтверждёнными — например, обновить одну цену за несколько минут и знать, что это удалось.
Что может пойти не так
- Ограничения частоты: платформы ограничивают число запросов в минуту от одного клиента, поэтому массовые обновления нужно распределять во времени.
- Смена версий: провайдеры выводят из эксплуатации старые версии API, и интеграции нужно вовремя обновлять.
- Несовпадение полей: при неправильном сопоставлении цена со скидкой в одной системе может попасть в обычную цену в другой.
- Частичные сбои: одни запросы проходят, другие нет, и данные остаются обновлёнными наполовину.
- Тихие ошибки: интеграция, которая останавливается, никого не предупредив, может на несколько дней оставить на сайте устаревшие цены.
Большинство из этих проблем закрывают две меры защиты. Во-первых, записывайте в журнал каждый запрос и ответ, чтобы проблемы можно было отследить. Во-вторых, контролируйте результаты, например после каждого обновления сверяйте выборку живых цен с намеченными.
Как спланировать надёжную интеграцию
- Определите, какая система является источником истины для каждого поля, например цены, остатка или названия товара.
- Тщательно сопоставьте поля, включая валюту, налоговые настройки и идентификаторы вариантов.
- Протестируйте на тестовом магазине или на нескольких товарах, прежде чем включать весь каталог.
- Задайте ограничения, например максимальное изменение цены за одно обновление, чтобы ошибочные входные данные не распространялись.
- Назначьте ответственного, который получает оповещения об ошибках и просматривает журналы.
Чёткая ответственность важна не меньше, чем код. Когда человек, настроивший интеграцию, уходит, короткое письменное описание того, что она делает, какие ключи использует и где хранятся её журналы, избавляет следующего сотрудника от множества догадок.
Главное
- Интеграция по API соединяет системы через заданный интерфейс, чтобы они автоматически обменивались данными.
- В электронной коммерции интеграции передают цены, остатки, товары и заказы между магазинами и инструментами.
- Webhook мгновенно передаёт события, а запросы API получают или отправляют данные по требованию.
- Ограничения частоты, несовпадение полей и тихие сбои — самые частые проблемы.
- Назначьте источник истины для каждого поля, сначала тестируйте на небольшом наборе и контролируйте каждое обновление.
Частые вопросы
Что означает API?
API — это интерфейс прикладного программирования (application programming interface). Это заданный способ, которым одна программа запрашивает данные или действия у другой.
Нужен ли разработчик, чтобы настроить интеграцию по API?
Не всегда. Многие инструменты предлагают готовые коннекторы: достаточно войти в аккаунт или вставить ключ и выбрать настройки. Индивидуальные интеграции между системами без готового коннектора обычно требуют разработки.
Чем API отличается от webhook?
При вызове API одна система сама решает, когда запросить данные у другой или отправить ей изменение. При webhook другая система автоматически отправляет уведомление, когда происходит событие. Многие интеграции используют и то, и другое.
Безопасна ли интеграция по API?
Может быть безопасной, если ключи хранятся в тайне, права ограничены необходимым, а соединения зашифрованы. Проверяйте, какие интеграции имеют доступ к вашему магазину, и удаляйте те, которыми больше не пользуетесь.
Связанные термины
В BlackAha Store Platform Integration помогает подключить ваш магазин, чтобы автоматически синхронизировать цены товаров.