API BenimPOS: ключи, тестовый аккаунт и документация
Как получить ключи API, общий тестовый аккаунт, документация для разработчиков (benimpos.com/developers) и частые вопросы.
API BenimPOS даёт доступ к данным вашего аккаунта из вашей собственной программы: можно передавать товары, остатки и цены в интернет-магазин, записывать заказы с сайта в BenimPOS как продажи, выгружать в бухгалтерскую или отчётную систему продажи, клиентов, поставщиков, приходные накладные и доходы-расходы.
Модуль API платный — 1.800,00 TL в год; он покупается на вкладке Интеграции › Интеграция по API. Отдельной тестовой среды нет; для проверки используйте общий тестовый аккаунт (см. ниже). Через API нельзя отправить чек на фискальный регистратор; интеграции с фискальными регистраторами работают только внутри приложений BenimPOS.
Документация API
Все сервисы, параметры, примеры запросов и ответов, коды ошибок и лимиты использования описаны на нашей странице для разработчиков: benimpos.com/developers. Страница доступна на турецком и английском языках. Любую операцию можно выполнить прямо в браузере кнопкой Dene (Try) и посмотреть ответ.
О новых сервисах и изменениях в API сообщается на странице Что нового. Старая документация в PDF больше не обновляется; по названиям полей и поведению ориентируйтесь на страницу для разработчиков.
Получение ключей API
Купите модуль
В веб-панели на странице Интеграции в самом низу левого меню откройте вкладку Интеграция по API и завершите покупку кнопкой Купить на карточке.
Откройте свои данные
После покупки в таблице вверху страницы появится строка Интеграция по API. Нажмите значок карандаша в строке — откроется окно Ваши данные интеграции по API.
Скопируйте значения
В окне три значения: Branch ID (код магазина), Api Key и Secret Key. Скопируйте их значком копирования и введите в настройки вашей программы.
Ключи дают полный доступ к вашему аккаунту: не записывайте их в репозиторий кода, в код, работающий в браузере (JavaScript), или в сообщения; храните их только на сервере. Если считаете, что ключ попал в чужие руки, создайте новый значком обновления в окне; старый ключ сразу перестаёт действовать, не забудьте обновить значение в своей программе.
- Каждый филиал — отдельный аккаунт со своим Branch ID и ключами. Модуль API включается отдельно в каждом аккаунте филиала, к данным которого нужен доступ.
- После окончания срока модуля сервисы работают ещё 3 дня, затем запросы отклоняются. Продлите срок кнопкой Продлить на странице «Интеграции».
Тестовый аккаунт
Запросы читают и изменяют реальные данные вашего аккаунта. Чтобы не трогать свои данные при разработке интеграции, используйте общий тестовый аккаунт. Данные для входа — в разделе Тестовый аккаунт документации API: войдите, возьмите ключи в строке Интеграции › Интеграция по API и используйте их в своей программе или на экране Dene (Try) в документации.
Тестовый аккаунт общедоступен; данные в нём может видеть и менять кто угодно. Не вводите туда реальные данные клиентов или продаж.
Кратко
| Параметр | Значение |
|---|---|
| Адрес | https://dev.benimpos.com/api/<servis> (например, /api/products) |
| Метод | POST, тело в JSON, не более 2 МБ |
| Аутентификация | HTTP-заголовки: Branch-ID, Api-Key, Secret-Key |
| Выбор операции | Поле processType в теле запроса (например, "list", "create") |
| Сервисы | Товары и приходные накладные (products), клиенты (customers), продажи (sales), поставщики (firms), категории (categories), способы оплаты (paymentTypes), доходы и расходы (incomeExpenses) |
Частые вопросы
Можно создать приходную накладную через API?
Да. Операция createPurchaseInvoice сервиса товаров сохраняет накладную, приходует товары на остаток, а для накладной «в долг» записывает сумму на счёт поставщика. При повторной отправке той же накладной новая запись не создаётся.
Можно назначить товару группу (категорию) через API?
Нет, при добавлении и изменении товара поля группы нет. Группы можно прочитать сервисом categories, а назначить группу товарам — в веб-панели или через Excel.
Как сделать, чтобы один заказ не записался как продажа дважды?
При создании продажи укажите в поле externalRef свой номер заказа. Повторный запрос с тем же номером не создаёт новую продажу, а возвращает код первой.
Когда продажа из программы для Windows появится в API?
После того как программа для Windows отправит данные в веб-панель (синхронизация). В программе для Windows синхронизацию можно запустить сразу из карточки «Интеграция данных» на главной странице. Продажи из веб-панели и мобильного приложения видны сразу.
Как получить техническую поддержку?
Напишите свой вопрос на [email protected]. Укажите время запроса, адрес, тело (без ключей), код HTTP-статуса, текст ответа и, если есть, заголовки ответа, начинающиеся с X-BP-. Не передавайте свои ключи API.