logo

API bonoos.ru

Общие данные

  • API построено по технологии REST
  • Все ресурсы приватные и требуют наличия в заголовке "Authorization" токена
  • спользуются стандартные HTTP коды.
  • Скачать пример для POSTMAN
  • Интеграция подразумевает использование как исходящих так и входящих (webhooks) запросов.

Интеграция с bonoos.ru подразумевает обмен данными в обе стороны (от bonoos.ru в вашу текущую систему и наоборот, от вашей текущей системы к bonoos.ru). Примером вашей текущей системы может быть касса или другая система лояльности.

Перечень эндпоинтов

Синхронизация клиента
bonoos.ru -> касса. Создает или обновляет запись с данными клиента.
Новая операция клиента
касса -> bonoos.ru. Создает запись о новой операции (транзакции).
Новая операция для пачки клиентов
касса -> bonoos.ru. Создает запись о новых операциях (транзакции).

Новый клиент

Когда в системе bonoos.ru создается клиент, можно синхронизовать запись с вашим кассовым софтом. То есть в данном случае осуществляется вызов URL от bonoos.ru к вашему кассовому софту.

Активировать эту функциональность можно создав в разделе "Интеграции -> Исходящие" параметры запроса.

Рисунок 1 - Экран настройки Интеграции, "Исходящие"

Параметры запроса можно настроить в форме настройки запроса.

Можно настроить:

  • HTTP method
  • Значение ключа
  • Название заголовка ключа
  • как передать параметры (в теле запроса или )
  • Названия полей

Синхронизация бонусов (кэшбэк)

При осуществлении транзакции в кассе необходимо отразить текущий статус и кэшбек на bonoos.ru. Таким образом произодет синхронизация с карточкой в Apple и/или Google Wallet клиента. Для этого нужно "прокинуть" данные на bonoos.ru.
То есть в данном случае осуществляется вызов URL касса -> bonoos.ru.

Синхронизация 1 транзакции

URL
https://TENANT_SLUG.bonoos.ru/api/public/v1/client/CLIENT_UUID/credit/update/
Method
POST
Authorization
Token
Body
{ "amount": 123400, "loyaltyProgramId": "5", "transactionId": "ABC12345", }

Описание полей

amount
Целочисленное значение в условных копейках. Пример: значение 120 отправить как 12000.
loyaltyProgramId
Айдишник программы лояльности. Это значени должно присутствовать в обеих системах.
transactionId
Айдишник транзакйии в вашей системе. Используется для фильтрации дублирующих операции.

Синхронизация списка транзакции

URL
https://TENANT_SLUG.bonoos.ru/api/public/v1/client/ops/add/
Method
POST
Authorization
Token
Body
{ clients: [ { "clientId": 12345 "amount": 123400, "loyaltyProgramId": "5", "transactionId": "ABC12345", }, ] }

Описание полей

clientId
Айдишник клиента полученный при получении запроса от bonoos.ru
amount
Целочисленное значение в условных копейках. Пример: значение 120 отправить как 12000.
loyaltyProgramId
Айдишник программы лояльности. Это значени должно присутствовать в обеих системах.
transactionId
Айдишник транзакйии в вашей системе. Используется для фильтрации дублирующих операции.