Прием данных осуществляется методом GET или POST. Внешняя система (1С или другая) вызывает REST-обработчик сайта и создает операции бонусов.
Маркетинг → Модуль накопительных баллов → Системные настройки → вкладка "Внешний обмен" → блок "Прием данных из 1С на сайт"
Адрес для направления запросов:
https://адрес_сайта/bitrix/tools/logictim.balls/rest/Сайт определяет тип запроса автоматически. Примеры ниже описаны в виде GET-запросов.
На сайте необходимо создать пользователя с доступом администратора и при каждом запросе передавать логин и пароль для авторизации на сайте:
access_login;access_password.Для того чтобы можно было сопоставить пользователей сторонней системы с пользователями сайта, имеется настройка идентификации пользователей.
Устанавливается в настройках бонусной системы на вкладке "Внешний обмен".
В запросах в поле USER необходимо передать значение поля, по которому производится идентификация.
Идентификация возможна по:
Параметры запроса:
| Параметр | Описание | Тип данных | Обязательный |
|---|---|---|---|
action |
GET_BALLANCE |
Фиксированное значение | Да |
USER |
Пользователь, чей баланс получаем* | строка или число | Да |
access_login |
Логин для авторизации на сайте | строка | Да |
access_password |
Пароль для авторизации на сайте | строка | Да |
* Значение поля, выбранного в настройке идентификации пользователей.
Ответ:
| Успешный ответ | Ответ с ошибкой |
|---|---|
RESULT : SUCCESSUSER_ID : ID пользователяUSER_BALLANCE : текущий баланс пользователя
|
RESULT : ERRORERROR : список ошибок
|
Параметры запроса:
| Параметр | Описание | Тип данных | Обязательный |
|---|---|---|---|
action |
ADD_BONUS |
Фиксированное значение | Да |
USER |
Пользователь, которому начисляем бонус* | строка или число | Да |
operation_type |
Тип операции (за что начисление) |
Варианты:ADD_FROM_ORDER - начисление за заказUSER_BALLANCE_CHANGE - изменение баланса пользователяBACK_FROM_CANCEL - возврат баллов за отмененный заказBACK_FROM_DELETTE - возврат баллов за удаленный заказADD_FROM_REGISTER - начисление при регистрацииADD_FROM_BIRTHDAY - начисление на день рожденияADD_FROM_REPOST - начисление за репостADD_FROM_REVIEW - начисление за отзывADD_FROM_LINK - начисление за переход по ссылкеADD_FROM_REFERAL - начисление за заказ рефералаADD_FROM_SUBSCRIBE - начисление за подписку
|
Нет. По умолчанию: USER_BALLANCE_CHANGE |
operation_name |
Наименование операции | строка | Нет. По умолчанию будет указано по типу операции |
operation_sum |
Сумма начисления | число | Да |
deactive_date |
Дата сгорания начисляемых бонусов | дата в формате 01.01.2024 |
Нет. По умолчанию 01.01.3000 |
external_id |
Внешний ID операции (например, ID транзакции в 1С) для идентификации операции. Если на сайте уже создана операция с данным кодом, то повторно она создана не будет | строка или число | Нет. По умолчанию REST_API |
access_login |
Логин для авторизации на сайте | строка | Да |
access_password |
Пароль для авторизации на сайте | строка | Да |
* Значение поля, выбранного в настройке идентификации пользователей.
Ответ:
| Успешный ответ | Ответ с ошибкой |
|---|---|
RESULT : SUCCESSUSER_ID : ID пользователяOPERATION_ID : ID созданной операции на сайте
|
RESULT : ERRORERROR : список ошибок
|
Параметры запроса:
| Параметр | Описание | Тип данных | Обязательный |
|---|---|---|---|
action |
MINUS_BONUS |
Фиксированное значение | Да |
USER |
Пользователь, которому списываем бонусы* | строка или число | Да |
operation_type |
Тип операции (за что списание) |
Варианты:MINUS_FROM_ORDER - списание по заказуUSER_BALLANCE_CHANGE - изменение баланса пользователяDEACIVATE_FROM_DATE - деактивация просроченных бонусовEXIT_BONUS - выплата бонусовMINUS_FROM_ORDER_CANCEL - отмена бонусов за заказ
|
Нет. По умолчанию: USER_BALLANCE_CHANGE |
operation_name |
Наименование операции | строка | Нет. По умолчанию будет указано по типу операции |
operation_sum |
Сумма списания | число | Да |
external_id |
Внешний ID операции (например, ID транзакции в 1С) для идентификации операции. Если на сайте уже создана операция с данным кодом, то повторно она создана не будет | строка или число | Нет. По умолчанию REST_API |
access_login |
Логин для авторизации на сайте | строка | Да |
access_password |
Пароль для авторизации на сайте | строка | Да |
* Значение поля, выбранного в настройке идентификации пользователей.
Ответ:
| Успешный ответ | Ответ с ошибкой |
|---|---|
RESULT : SUCCESSUSER_ID : ID пользователяOPERATION_ID : ID созданной операции на сайте
|
RESULT : ERRORERROR : список ошибок
|
Параметры запроса:
| Параметр | Описание | Тип данных | Обязательный |
|---|---|---|---|
action |
UPDATE_BALLANCE |
Фиксированное значение | Да |
USER |
Пользователь, чей баланс обновляем* | строка или число | Да |
new_ballance |
Новый баланс пользователя, который будет установлен | число | Да |
operation_name |
Наименование операции | строка | Нет. По умолчанию: "Обновление баланса" |
deactive_date |
Дата сгорания начисляемых бонусов, если новый баланс больше начального и бонусы доначисляются | дата в формате 01.01.2024 |
Нет. По умолчанию 01.01.3000 |
external_id |
Внешний ID операции (например, ID транзакции в 1С) для идентификации операции. Если на сайте уже создана операция с данным кодом, то повторно она создана не будет | строка или число | Нет. По умолчанию REST_API |
access_login |
Логин для авторизации на сайте | строка | Да |
access_password |
Пароль для авторизации на сайте | строка | Да |
* Значение поля, выбранного в настройке идентификации пользователей.
Ответ:
| Успешный ответ | Ответ с ошибкой |
|---|---|
RESULT : SUCCESSUSER_ID : ID пользователяUSER_BALLANCE : установленный балансOPERATION_ID : ID созданной операции на сайте(если новый и начальный баланс одинаковы, операция не создается и параметр в ответе отсутствует) |
RESULT : ERRORERRORS : список ошибок
|
https://сайт/bitrix/tools/logictim.balls/rest/?action=ADD_BONUS&USER=123&operation_sum=100&external_id=1C-456&access_login=...&access_password=...См. также: как устроен обмен, передача данных в 1С.