Прием данных осуществляется методом GET или POST.
Адрес для направления запросов: https://адрес_сайта/bitrix/tools/logictim.balls/rest/
Сайт определяет тип запроса автоматически.
Примеры будут описаны в виде GET запросов.
Авторизация при отправке запросов:
На сайте необходимо создать пользователя с доступами администратора, и при каждом запросе передавать логин и пароль пользователя для авторизации на сайте:
Логин передается в ключе access_login
Пароль передается в ключе access_password
Идентификация пользователей
Для того чтобы можно было сопоставить пользователей сторонней системы с пользователями сайта, имеется настройка идентификации пользователей.
Устанавливается в настройках бонусной системы на вкладке "Внешний обмен".
В запросах в поле USER необходимо передать значение поля, по которому производится идентификация.
Идентификация возможна по:
- ID пользователя, - Внешнему
ID пользователя,
- Логину, - E-mail,
- номеру телефона регистрации (поле битрикс "Номер телефона для регистрации"),
- по 10 цифрам номера телефона. Можно передать 10 последних цифр номера телефона, и модуль сам найдет пользователя с данным номером телефона,
- по любому пользовательскому свойству строкового, или числового типа
(например можно создать свойство "Номер карты" и производлить идентификацию по нему)
Параметры запроса:
Параметр | Описание | Тип данных | Обязательный |
---|---|---|---|
action | GET_BALLANCE | Фиксированное значение | Да |
USER | Пользователь чей баланс получаем* | строка, или число | Да |
access_login | Логин для авторизации на сайте | строка | Да |
access_password | Пароль для авторизации на сайте | строка | Да |
Ответ:
Успешный ответ | Ответ с ошибкой |
---|---|
RESULT : SUCCESS USER_ID : ID пользователя USER_BALLANCE : текущий баланс пользователя | RESULT : ERROR ERROR: список ошибок |
Параметры запроса:
Параметр | Описание | Тип данных | Обязательный |
---|---|---|---|
action | ADD_BONUS | Фиксированное значение | Да |
USER | Пользователь которому начисляем бонус* | строка, или число | Да |
operation_type | Тип операции (за что начисление) | Варианты: ADD_FROM_ORDER - Начисление за заказ |
Нет. По умолчанию: 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 : SUCCESS USER_ID : ID пользователя OPERATION_ID : ID созданной операции на сайте | RESULT : ERROR ERROR: список ошибок |
Параметры запроса:
Параметр | Описание | Тип данных | Обязательный |
---|---|---|---|
action | MINUS_BONUS | Фиксированное значение | Да |
USER | Пользователь которому списываем бонусы* | строка, или число | Да |
operation_type | Тип операции (за что списание) | Варианты: MINUS_FROM_ORDER - Списание по заказу |
Нет. По умолчанию: USER_BALLANCE_CHANGE |
operation_name | Наименование операции | строка | Нет. По умолчанию будет указано по типу операции. |
operation_sum | Сумма списания | число | Да. |
external_id | Внешний ID операции (например ID транзакции в 1С) для идентификации операции. Если на сайте уже создана операция с данным кодом, то повторно она создана не будет. |
строка, или чило | Нет. По умолчанию REST_API |
access_login | Логин для авторизации на сайте | строка | |
access_password | Пароль для авторизации на сайте | строка |
Ответ:
Успешный ответ | Ответ с ошибкой |
---|---|
RESULT : SUCCESS USER_ID : ID пользователя OPERATION_ID : ID созданной операции на сайте | RESULT : ERROR ERROR: список ошибок |
Параметры запроса:
Параметр | Описание | Тип данных | Обязательный |
---|---|---|---|
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 : SUCCESS USER_ID : ID пользователя USER_BALLANCE: установленный баланс OPERATION_ID : ID созданной операции на сайте (если новый и начальный баланс одинаковы, то операция не создается, и данный параметр в ответе отсутствует) | RESULT : ERROR ERRORS: список ошибок |
Logictim - официальный сертифицированный партнер 1С-Битрикс, AMO CRM, Rusonyx
Вы можете связаться с нами любым из перечисленных способов:
Телефон: +7 (843) 212-62-17
Email: info@logictim.ru
Адрес: г. Казань, ул. Дубравная 38, офис 4
Режим работы: пн-пт с 10:00 до 18:00
Наши несколько основных принципов:
- Открытый и честный подход
- Стоимость пропорциональна объему работ
- Качественное исполнение
Наш менеджер свяжется с Вами в ближайшее время!