Интеграция через API: простыми словами

Слово «API» часто произносят программисты, а руководители стесняются спросить, что оно значит. Идея на самом деле простая: API — набор правил, по которым одна программа запрашивает данные у другой или отправляет их ей. В инвентаризации он избавляет от ручной загрузки файлов туда и обратно. Ниже о том, что такое API, какие данные ходят во время подсчёта и когда он лучше обмена файлами.

Что такое API

Представьте ресторан. Вы (одна программа) делаете заказ официанту (API), официант несёт его на кухню (вторая программа) и приносит готовое блюдо. Вы не заходите на кухню, а официант принимает только то, что есть в меню. API работает так же: программа отправляет другой программе только разрешённые запросы и получает ответ. Запрос обычно идёт через интернет в виде простого текста в формате JSON.

Какие данные ходят в инвентаризации

В подсчёте есть два потока:

• Перед подсчётом ваша система (1С, ERP или сайт) отправляет в программу подсчёта список товаров: артикул, название, код, остаток.
• Во время подсчёта или после него программа подсчёта возвращает результат: посчитанное количество, время, сотрудник.

Дополнительно передаётся статус сессии: «началась», «завершена». Польза понятна: список не нужно загружать вручную, коды не портятся при копировании (ведущие нули не пропадают), риск считать по устаревшему списку снижается, а результат попадает в учёт за несколько минут. Подключение должно быть только между вашей системой и программой подсчёта: оно защищается токеном и не остаётся открытым для всех.

Несколько терминов

Разговаривая с программистом, вы часто услышите такие слова:

• Endpoint — конкретный адрес, на который отправляется запрос, например адрес «получить список товаров».
• Токен — длинная секретная строка, по которой программа представляется системе. Храните его как пароль: не бросайте в чат, не записывайте в открытый файл, меняйте, если сотрудник ушёл.
• Webhook — сообщение «работа завершена». Когда сессия закрыта, программа подсчёта сама подаёт сигнал на ваш адрес, и не нужно каждую минуту спрашивать «закончили?».
• JSON — текстовый формат, в котором данные записываются парами «ключ: значение»; по сути, текстовое представление таблицы Excel.
• Лимит — сколько запросов можно отправить в минуту. При превышении система временно перестанет отвечать.
• Коды ошибок: 200 «всё в порядке», 401 «нет доступа», 404 «не найдено», 500 «ошибка сервера».

Файл или API: что нужно

Пример. У интернет-магазина два склада. Каждое утро система отправляет в программу подсчёта остатки с учётом вчерашних продаж, кладовщик считает тридцать-сорок позиций, вечером расхождения возвращаются в систему, а руководитель получает задачу на проверку. С файлами это пришлось бы каждый день загружать и выгружать вручную; с API человек только считает и утверждает.

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

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

Чек-лист перед запуском

Прежде чем ставить задачу программисту, подготовьте ответы на вопросы:

1. В каком направлении идут данные: список из системы в программу подсчёта, а результат обратно?
2. Какие поля нужны: артикул, код, название, остаток, единица, зона?
3. Как часто: один раз перед подсчётом или каждый час?
4. Что делать при ошибке: повторять ли запрос при обрыве связи и как не получить один результат дважды?
5. Тест: проверять ли сначала на копии, а не на рабочей базе?
6. К кому обращаться, если система перестала работать?

Вывод

API — не магия, а простая договорённость: кто кому, что, в каком виде и когда отправляет. Его ценность проявляется там, где пересчёты проходят часто, а данных много. Сначала лучше отладить процесс на файлах. Если хотите передать подсчёт специалистам, StockCheck отдаёт результат в Excel, PDF или файлом для 1С.