external:pro_bonus:10_probonus_api:08_config

Book creator
 Добавить страницу в книгу
Book creator
 Удалить страницу из книги  

 Показать или изменить шаблон книги(0 страниц(ы))
 Помощь

Это старая версия документа!

ProBonus API: Настройки сервера

Чтение и изменение настроек ProBonus: БД, связь с r_keeper, антифрод, боты, Wallet, рассылки, политики, реферальная программа, ИИ.

Общие правила (адрес, авторизация, форматы, коды ошибок) — на странице ProBonus API. Справочник методов.

Список методов

Метод Адрес Назначение
GET /api/v0/config/ai/get Чтение настроек ИИ для отзывов
POST /api/v0/config/ai/update Изменение настроек ИИ для отзывов
GET /api/v0/config/anti_fraud/get Чтение настроек Антифрода
POST /api/v0/config/anti_fraud/notifications_tg_bot/register Чтение списка получателей зарегистрировавшихся для получения уведомлений по событиям Антифрод
POST /api/v0/config/anti_fraud/notifications_tg_bot/update_receiver Блокировка/разблокировка получателей уведомлений по событиям "Антифрода"
POST /api/v0/config/anti_fraud/update Обновление настроек Антифрода
GET /api/v0/config/api_version Версия API
GET /api/v0/config/app_version Запрос версии приложения ProBonus
GET /api/v0/config/application/get Чтение настроек ПО ProBonus
POST /api/v0/config/application/update Обновление настроек ПО ProBonus
POST /api/v0/config/cash_settings/delete Удаление профиля регистрации с кассы
GET /api/v0/config/cash_settings/get Чтение профиля регистрации с кассы по id
GET /api/v0/config/cash_settings/get_by_token Чтение профиля регистрации с кассы по токену
POST /api/v0/config/cash_settings/insert Добавление профиля регистрации с кассы
GET /api/v0/config/cash_settings/list Список профилей регистрации с кассы
POST /api/v0/config/cash_settings/update Изменение профиля регистрации с кассы
GET /api/v0/config/db/available_databases Ввод строки соединения с БД
GET /api/v0/config/db/available_drivers Запрос доступного драйвера для БД клиента
GET /api/v0/config/db/check_connection_string Проверка настроек соединения с БД
GET /api/v0/config/db/connection_string Запрос строки соединения с БД
POST /api/v0/config/db/create Создание структуры БД
GET /api/v0/config/db/info Запрос информации о БД
POST /api/v0/config/db/update Обновление версии БД (при обновлении версии ПО)
POST /api/v0/config/db/update_connection_string Обновление строки соединения с БД
GET /api/v0/config/info_kiosk/get Чтение настроек инфокиоска
POST /api/v0/config/info_kiosk/update Изменение настроек инфокиоска
GET /api/v0/config/mailing/get Чтение настроек рассылок
POST /api/v0/config/mailing/update Изменение настроек рассылок
GET /api/v0/config/max_bot/get Чтение настроек MAX-бота
GET /api/v0/config/max_bot/get_bot_info Информация о MAX-боте по токену
GET /api/v0/config/max_bot/get_phrases_meta Список настраиваемых фраз MAX-бота
POST /api/v0/config/max_bot/update Изменение настроек MAX-бота
GET /api/v0/config/max_bot/validate_token Проверка токена MAX-бота
GET /api/v0/config/policies/get Чтение текстов политик и согласий
POST /api/v0/config/policies/update Изменение текстов политик и согласий
GET /api/v0/config/r_keeper/bonus_types/get Чтение справочника "Тип бонуса" из r_keeper
GET /api/v0/config/r_keeper/connection/check Проверка связи с r_keeper
GET /api/v0/config/r_keeper/connection/get Чтение настроек связи с r_keeper
POST /api/v0/config/r_keeper/connection/update Обновление настроек связи с r_keeper
GET /api/v0/config/r_keeper/discounts/get Чтение справочника "Скидки" из r_keeper
GET /api/v0/config/r_keeper/extended/get Чтение кода "Нулевой скидки"
POST /api/v0/config/r_keeper/extended/update Обновление кода "Нулевой скидки"
GET /api/v0/config/r_keeper/menu_items/get Чтение справочника "Меню" из r_keeper
GET /api/v0/config/referral_program/get Чтение настроек реферальной программы
POST /api/v0/config/referral_program/update Изменение настроек реферальной программы
GET /api/v0/config/server/get Чтение настроек сервера Probonus
POST /api/v0/config/server/update Обновление настроек сервера Probonus
GET /api/v0/config/telegram_bot/get Чтение настроек Telegram-бота
GET /api/v0/config/telegram_bot/get_bot_info Информация о Telegram-боте по токену
GET /api/v0/config/telegram_bot/get_phrases_meta Список настраиваемых фраз Telegram-бота
POST /api/v0/config/telegram_bot/import_config Импорт настроек Telegram-бота из файла
POST /api/v0/config/telegram_bot/import_description_and_politics Импорт описания и политик Telegram-бота из файла
POST /api/v0/config/telegram_bot/update Изменение настроек Telegram-бота
GET /api/v0/config/wallet/card_templates/get Чтение шаблона карты Wallet
POST /api/v0/config/wallet/card_templates/insert Добавление шаблона карты Wallet
GET /api/v0/config/wallet/card_templates/list Список шаблонов карт Wallet
POST /api/v0/config/wallet/card_templates/update Изменение шаблона карты Wallet
GET /api/v0/config/wallet/locations/get Чтение геолокаций Wallet
POST /api/v0/config/wallet/locations/update Изменение геолокаций Wallet
GET /api/v0/config/wallet_guest_form/get Чтение настроек формы гостя Wallet
POST /api/v0/config/wallet_guest_form/update Изменение настроек формы гостя Wallet
GET /api/v0/config/wallet_main/get Чтение основных настроек Wallet
POST /api/v0/config/wallet_main/update Изменение основных настроек Wallet

Настройки

Чтение настроек ИИ для отзывов

GET /api/v0/config/ai/get

Авторизация: требуется

Ответ 200 — объект AiConfigGetDto:

Поле Тип Обяз. Описание
useAiForAutoReview boolean да Автоматически анализировать отзывы с помощью ИИ
autoReviewPrompt string Запрос (prompt) для ИИ
autoReviewDelay integer да Задержка перед анализом отзыва
autoReviewToGrades массив integer Оценки на которые отвечает ai. По умолчанию все возможные 1, 2, 3, 4, 5

Изменение настроек ИИ для отзывов

POST /api/v0/config/ai/update

Авторизация: требуется

Тело запроса — объект AiConfigGetDto:

Поле Тип Обяз. Описание
useAiForAutoReview boolean да Автоматически анализировать отзывы с помощью ИИ
autoReviewPrompt string Запрос (prompt) для ИИ
autoReviewDelay integer да Задержка перед анализом отзыва
autoReviewToGrades массив integer Оценки на которые отвечает ai. По умолчанию все возможные 1, 2, 3, 4, 5

Ответ 200 — объект AiConfigGetDto:

Поле Тип Обяз. Описание
useAiForAutoReview boolean да Автоматически анализировать отзывы с помощью ИИ
autoReviewPrompt string Запрос (prompt) для ИИ
autoReviewDelay integer да Задержка перед анализом отзыва
autoReviewToGrades массив integer Оценки на которые отвечает ai. По умолчанию все возможные 1, 2, 3, 4, 5

Чтение настроек Антифрода

GET /api/v0/config/anti_fraud/get

Авторизация: требуется

Ответ 200 — объект AntiFraudSettingsGetDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
controlPerDay boolean да Антифрод: контролировать применения за день
dayNotifyAfter integer да Антифрод: предупреждение после N применений за день
dayBlockAfter integer да Антифрод: блокировка после N применений за день
controlPerWeek boolean да Антифрод: контролировать применения за неделю
weekNotifyAfter integer да Антифрод: предупреждение после N применений за неделю
weekBlockAfter integer да Антифрод: блокировка после N применений за неделю
controlPerMonth boolean да Антифрод: контролировать применения за месяц
monthNotifyAfter integer да Антифрод: предупреждение после N применений за месяц
monthBlockAfter integer да Антифрод: блокировка после N применений за месяц
enableEmailsNotifications boolean да Отправлять уведомления на e-mail
emailsToNotify массив AntiFraudEmailItemDto да Адреса для уведомлений
useSelfSmtpServer boolean да Использовать собственный SMTP-сервер
smtpUseSsl boolean да SMTP: использовать SSL
smtpHost string да SMTP: сервер
smtpPort integer да SMTP: порт
smtpUsername string да SMTP: имя пользователя
enableTelegramNotifications boolean да Отправлять уведомления в Telegram
exceptions AntiFraudSettingsExceptionsGetDto да Исключения

Чтение списка получателей зарегистрировавшихся для получения уведомлений по событиям Антифрод

POST /api/v0/config/anti_fraud/notifications_tg_bot/register

Авторизация: требуется

Ответ 200 — объект AntiFraudBotRestaurantInfoDto:

Поле Тип Обяз. Описание
name string да Наименование
guid uuid да
receivers массив AntiFraudRestaurantReceiverDto да
botUrl string (URL)(2083) да мин. длина 1

Блокировка/разблокировка получателей уведомлений по событиям "Антифрода"

POST /api/v0/config/anti_fraud/notifications_tg_bot/update_receiver

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
user_id строка запроса integer да Идентификатор пользователя

Тело запроса — объект AntiFraudBotReceiverBaseDto:

Поле Тип Обяз. Описание
isBlocked boolean да Заблокирован

Ответ 200 — объект AntiFraudBotReceiverWithUserIdDto:

Поле Тип Обяз. Описание
isBlocked boolean да Заблокирован
userId integer да Идентификатор пользователя

Обновление настроек Антифрода

POST /api/v0/config/anti_fraud/update

Авторизация: требуется

Тело запроса — объект AntiFraudSettingsUpdateDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
controlPerDay boolean да Антифрод: контролировать применения за день
dayNotifyAfter integer да Антифрод: предупреждение после N применений за день
dayBlockAfter integer да Антифрод: блокировка после N применений за день
controlPerWeek boolean да Антифрод: контролировать применения за неделю
weekNotifyAfter integer да Антифрод: предупреждение после N применений за неделю
weekBlockAfter integer да Антифрод: блокировка после N применений за неделю
controlPerMonth boolean да Антифрод: контролировать применения за месяц
monthNotifyAfter integer да Антифрод: предупреждение после N применений за месяц
monthBlockAfter integer да Антифрод: блокировка после N применений за месяц
enableEmailsNotifications boolean да Отправлять уведомления на e-mail
emailsToNotify массив AntiFraudEmailItemDto да Адреса для уведомлений
useSelfSmtpServer boolean да Использовать собственный SMTP-сервер
smtpUseSsl boolean да SMTP: использовать SSL
smtpHost string да SMTP: сервер
smtpPort integer да SMTP: порт
smtpUsername string да SMTP: имя пользователя
enableTelegramNotifications boolean да Отправлять уведомления в Telegram
smtpPassword string SMTP: пароль
exceptions AntiFraudSettingsExceptionsUpdateDto да Исключения

Ответ 200 — объект AntiFraudSettingsGetDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
controlPerDay boolean да Антифрод: контролировать применения за день
dayNotifyAfter integer да Антифрод: предупреждение после N применений за день
dayBlockAfter integer да Антифрод: блокировка после N применений за день
controlPerWeek boolean да Антифрод: контролировать применения за неделю
weekNotifyAfter integer да Антифрод: предупреждение после N применений за неделю
weekBlockAfter integer да Антифрод: блокировка после N применений за неделю
controlPerMonth boolean да Антифрод: контролировать применения за месяц
monthNotifyAfter integer да Антифрод: предупреждение после N применений за месяц
monthBlockAfter integer да Антифрод: блокировка после N применений за месяц
enableEmailsNotifications boolean да Отправлять уведомления на e-mail
emailsToNotify массив AntiFraudEmailItemDto да Адреса для уведомлений
useSelfSmtpServer boolean да Использовать собственный SMTP-сервер
smtpUseSsl boolean да SMTP: использовать SSL
smtpHost string да SMTP: сервер
smtpPort integer да SMTP: порт
smtpUsername string да SMTP: имя пользователя
enableTelegramNotifications boolean да Отправлять уведомления в Telegram
exceptions AntiFraudSettingsExceptionsGetDto да Исключения

Версия API

GET /api/v0/config/api_version

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Запрос версии приложения ProBonus

GET /api/v0/config/app_version

Авторизация: не требуется

Ответ 200 — string.

Чтение настроек ПО ProBonus

GET /api/v0/config/application/get

Авторизация: требуется

Ответ 200 — объект ApplicationSettingsDto:

Поле Тип Обяз. Описание
requirePhone boolean да Телефон обязателен
requireSex boolean да Пол обязателен
temporaryIdentifierValidMinutes integer да Срок действия временного кода, минут
temporaryIdentifierLength integer да Длина временного кода
language string да Язык
dayBound time да Время смены суток
cashShowBirthday boolean да Показывать на кассе день рождения гостя
cashShowBirthdayDaysBefore integer да Показывать день рождения за N дней до
cashShowBirthdayDaysAfter integer да Показывать день рождения N дней после
specialCases SpecialCasesDto да Особые случаи
applicationVersion string да Версия ProBonus
databaseVersion string Версия схемы БД
configOnly boolean да Только настройки

Обновление настроек ПО ProBonus

POST /api/v0/config/application/update

Авторизация: требуется

Тело запроса — объект ApplicationSettingsBaseDto:

Поле Тип Обяз. Описание
requirePhone boolean да Телефон обязателен
requireSex boolean да Пол обязателен
temporaryIdentifierValidMinutes integer да Срок действия временного кода, минут
temporaryIdentifierLength integer да Длина временного кода
language string да Язык
dayBound time да Время смены суток
cashShowBirthday boolean да Показывать на кассе день рождения гостя
cashShowBirthdayDaysBefore integer да Показывать день рождения за N дней до
cashShowBirthdayDaysAfter integer да Показывать день рождения N дней после
specialCases SpecialCasesDto да Особые случаи

Ответ 200 — объект ApplicationSettingsDto:

Поле Тип Обяз. Описание
requirePhone boolean да Телефон обязателен
requireSex boolean да Пол обязателен
temporaryIdentifierValidMinutes integer да Срок действия временного кода, минут
temporaryIdentifierLength integer да Длина временного кода
language string да Язык
dayBound time да Время смены суток
cashShowBirthday boolean да Показывать на кассе день рождения гостя
cashShowBirthdayDaysBefore integer да Показывать день рождения за N дней до
cashShowBirthdayDaysAfter integer да Показывать день рождения N дней после
specialCases SpecialCasesDto да Особые случаи
applicationVersion string да Версия ProBonus
databaseVersion string Версия схемы БД
configOnly boolean да Только настройки

Удаление профиля регистрации с кассы

POST /api/v0/config/cash_settings/delete

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 204: без содержимого.

Чтение профиля регистрации с кассы по id

GET /api/v0/config/cash_settings/get

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — объект CashRegistrationSettingsFullDto:

Поле Тип Обяз. Описание
name string да Наименование
settings CashRegistrationSettingsDto да Настройки
id integer да Идентификатор
token uuid да Токен доступа (уникальный)

Чтение профиля регистрации с кассы по токену

GET /api/v0/config/cash_settings/get_by_token

Авторизация: не требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
token строка запроса uuid да Токен

Ответ 200 — объект CashRegistrationSettingsFullDto:

Поле Тип Обяз. Описание
name string да Наименование
settings CashRegistrationSettingsDto да Настройки
id integer да Идентификатор
token uuid да Токен доступа (уникальный)

Добавление профиля регистрации с кассы

POST /api/v0/config/cash_settings/insert

Авторизация: требуется

Тело запроса — объект CashRegistrationSettingsBaseDto:

Поле Тип Обяз. Описание
name string да Наименование профиля
settings CashRegistrationSettingsDto да Настройки

Ответ 200 — объект CashRegistrationSettingsFullDto:

Поле Тип Обяз. Описание
name string да Наименование
settings CashRegistrationSettingsDto да Настройки
id integer да Идентификатор
token uuid да Токен доступа (уникальный)

Список профилей регистрации с кассы

GET /api/v0/config/cash_settings/list

Авторизация: требуется

Ответ 200 — массив объектов CashRegistrationSettingsFullDto:

Поле Тип Обяз. Описание
name string да Наименование
settings CashRegistrationSettingsDto да Настройки
id integer да Идентификатор
token uuid да Токен доступа (уникальный)

Изменение профиля регистрации с кассы

POST /api/v0/config/cash_settings/update

Авторизация: требуется

Тело запроса — объект CashRegistrationSettingsWithIdDto:

Поле Тип Обяз. Описание
name string да Наименование
settings CashRegistrationSettingsDto да Настройки
id integer да Идентификатор

Ответ 200 — объект CashRegistrationSettingsFullDto:

Поле Тип Обяз. Описание
name string да Наименование
settings CashRegistrationSettingsDto да Настройки
id integer да Идентификатор
token uuid да Токен доступа (уникальный)

Ввод строки соединения с БД

GET /api/v0/config/db/available_databases

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
pyodbc_connection_string строка запроса string Строка подключения к БД в формате pyodbc

Ответ 200 — массив string.

Запрос доступного драйвера для БД клиента

GET /api/v0/config/db/available_drivers

Авторизация: требуется

Ответ 200 — массив объектов OdbcDriverItem:

Поле Тип Обяз. Описание
value string да Значение

Проверка настроек соединения с БД

GET /api/v0/config/db/check_connection_string

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
pyodbc_connection_string строка запроса string Строка подключения к БД в формате pyodbc

Ответ 200 — объект DatabaseInfoDto:

Поле Тип Обяз. Описание
databaseName string Имя базы данных
databaseVersion string Версия схемы БД
compatibleDatabaseVersion string Версия схемы БД, совместимая с сервером
canCreate boolean Можно создать структуру БД; по умолчанию false
dbErrorMessage string Ошибка подключения к БД

Запрос строки соединения с БД

GET /api/v0/config/db/connection_string

Авторизация: требуется

Ответ 200 — string.

Создание структуры БД

POST /api/v0/config/db/create

Авторизация: требуется

Ответ 200 — объект DatabaseInfoDto:

Поле Тип Обяз. Описание
databaseName string Имя базы данных
databaseVersion string Версия схемы БД
compatibleDatabaseVersion string Версия схемы БД, совместимая с сервером
canCreate boolean Можно создать структуру БД; по умолчанию false
dbErrorMessage string Ошибка подключения к БД

Запрос информации о БД

GET /api/v0/config/db/info

Авторизация: требуется

Ответ 200 — объект DatabaseInfoDto:

Поле Тип Обяз. Описание
databaseName string Имя базы данных
databaseVersion string Версия схемы БД
compatibleDatabaseVersion string Версия схемы БД, совместимая с сервером
canCreate boolean Можно создать структуру БД; по умолчанию false
dbErrorMessage string Ошибка подключения к БД

Обновление версии БД (при обновлении версии ПО)

POST /api/v0/config/db/update

Авторизация: требуется

Ответ 200 — объект DatabaseInfoDto:

Поле Тип Обяз. Описание
databaseName string Имя базы данных
databaseVersion string Версия схемы БД
compatibleDatabaseVersion string Версия схемы БД, совместимая с сервером
canCreate boolean Можно создать структуру БД; по умолчанию false
dbErrorMessage string Ошибка подключения к БД

Обновление строки соединения с БД

POST /api/v0/config/db/update_connection_string

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
pyodbc_connection_string строка запроса string да Строка подключения к БД в формате pyodbc

Ответ 200 — объект DatabaseInfoDto:

Поле Тип Обяз. Описание
databaseName string Имя базы данных
databaseVersion string Версия схемы БД
compatibleDatabaseVersion string Версия схемы БД, совместимая с сервером
canCreate boolean Можно создать структуру БД; по умолчанию false
dbErrorMessage string Ошибка подключения к БД

Чтение настроек инфокиоска

GET /api/v0/config/info_kiosk/get

Авторизация: требуется

Ответ 200 — объект InfokioskSettingsDto:

Поле Тип Обяз. Описание
showInfoTimeout integer да Время показа информации, секунд
showErrorTimeout integer да Время показа ошибки, секунд
touchscreen boolean да Сенсорный экран
logoImage string Логотип
arrowImage string Изображение стрелки
backgroundImage string Фоновое изображение
logoPosition ImagePosition да Положение логотипа
arrowPosition ImagePosition да Положение стрелки

Изменение настроек инфокиоска

POST /api/v0/config/info_kiosk/update

Авторизация: требуется

Тело запроса — объект InfokioskSettingsDto:

Поле Тип Обяз. Описание
showInfoTimeout integer да Время показа информации, секунд
showErrorTimeout integer да Время показа ошибки, секунд
touchscreen boolean да Сенсорный экран
logoImage string Логотип
arrowImage string Изображение стрелки
backgroundImage string Фоновое изображение
logoPosition ImagePosition да Положение логотипа
arrowPosition ImagePosition да Положение стрелки

Ответ 200 — объект InfokioskSettingsDto:

Поле Тип Обяз. Описание
showInfoTimeout integer да Время показа информации, секунд
showErrorTimeout integer да Время показа ошибки, секунд
touchscreen boolean да Сенсорный экран
logoImage string Логотип
arrowImage string Изображение стрелки
backgroundImage string Фоновое изображение
logoPosition ImagePosition да Положение логотипа
arrowPosition ImagePosition да Положение стрелки

Чтение настроек рассылок

GET /api/v0/config/mailing/get

Авторизация: требуется

Ответ 200 — объект MailingSettingsDto:

Поле Тип Обяз. Описание
enableEmailMailing boolean да Включить рассылки по e-mail
smtpUseSsl boolean да SMTP: использовать SSL
smtpHost string да SMTP: сервер
smtpPort integer да SMTP: порт
smtpUsername string да SMTP: имя пользователя

Изменение настроек рассылок

POST /api/v0/config/mailing/update

Авторизация: требуется

Тело запроса — объект MailingSettingsWithSmtpPasswordDto:

Поле Тип Обяз. Описание
enableEmailMailing boolean да Включить рассылки по e-mail
smtpUseSsl boolean да SMTP: использовать SSL
smtpHost string да SMTP: сервер
smtpPort integer да SMTP: порт
smtpUsername string да SMTP: имя пользователя
smtpPassword string SMTP: пароль

Ответ 200 — объект MailingSettingsDto:

Поле Тип Обяз. Описание
enableEmailMailing boolean да Включить рассылки по e-mail
smtpUseSsl boolean да SMTP: использовать SSL
smtpHost string да SMTP: сервер
smtpPort integer да SMTP: порт
smtpUsername string да SMTP: имя пользователя

Чтение настроек MAX-бота

GET /api/v0/config/max_bot/get

Авторизация: требуется

Ответ 200 — объект MaxBotSettingsGetDto:

Поле Тип Обяз. Описание
config MaxBotFullConfigGetDto да Настройки
phrases object да Настраиваемые фразы бота

Информация о MAX-боте по токену

GET /api/v0/config/max_bot/get_bot_info

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
token строка запроса string да Токен

Ответ 200 — объект MaxBotInfo:

Поле Тип Обяз. Описание
userId integer да Идентификатор пользователя
name string да Наименование
username string Имя пользователя

Список настраиваемых фраз MAX-бота

GET /api/v0/config/max_bot/get_phrases_meta

Авторизация: требуется

Ответ 200 — object.

Изменение настроек MAX-бота

POST /api/v0/config/max_bot/update

Авторизация: требуется

Тело запроса — объект MaxBotSettingsUpdateDto:

Поле Тип Обяз. Описание
config MaxBotFullConfigUpdateDto да Настройки
phrases object да Настраиваемые фразы бота

Ответ 200 — объект MaxBotSettingsGetDto:

Поле Тип Обяз. Описание
config MaxBotFullConfigGetDto да Настройки
phrases object да Настраиваемые фразы бота

Проверка токена MAX-бота

GET /api/v0/config/max_bot/validate_token

Авторизация: требуется

Ответ 200 — объект MaxBotInfo:

Поле Тип Обяз. Описание
userId integer да Идентификатор пользователя
name string да Наименование
username string Имя пользователя

Чтение текстов политик и согласий

GET /api/v0/config/policies/get

Авторизация: требуется

Ответ 200 — объект PoliciesAndConsentsDto:

Поле Тип Обяз. Описание
personalPolicy string да Текст политики обработки персональных данных
argeement string да Текст соглашения
loyaltyRules string да Текст правил программы лояльности
argeementAdvertisement string да Текст согласия на рекламные рассылки
ageConfirmation string да Текст подтверждения возраста
requirePersonalPolicy boolean да Требовать принятие политики обработки ПД
showLoyaltyRules boolean да Показывать правила программы лояльности
requireAdvertisementAgreement boolean да Требовать согласие на рекламные рассылки
requireAgeConfirmation boolean да Требовать подтверждение возраста

Изменение текстов политик и согласий

POST /api/v0/config/policies/update

Авторизация: требуется

Тело запроса — объект PoliciesAndConsentsDto:

Поле Тип Обяз. Описание
personalPolicy string да Текст политики обработки персональных данных
argeement string да Текст соглашения
loyaltyRules string да Текст правил программы лояльности
argeementAdvertisement string да Текст согласия на рекламные рассылки
ageConfirmation string да Текст подтверждения возраста
requirePersonalPolicy boolean да Требовать принятие политики обработки ПД
showLoyaltyRules boolean да Показывать правила программы лояльности
requireAdvertisementAgreement boolean да Требовать согласие на рекламные рассылки
requireAgeConfirmation boolean да Требовать подтверждение возраста

Ответ 200 — объект PoliciesAndConsentsDto:

Поле Тип Обяз. Описание
personalPolicy string да Текст политики обработки персональных данных
argeement string да Текст соглашения
loyaltyRules string да Текст правил программы лояльности
argeementAdvertisement string да Текст согласия на рекламные рассылки
ageConfirmation string да Текст подтверждения возраста
requirePersonalPolicy boolean да Требовать принятие политики обработки ПД
showLoyaltyRules boolean да Показывать правила программы лояльности
requireAdvertisementAgreement boolean да Требовать согласие на рекламные рассылки
requireAgeConfirmation boolean да Требовать подтверждение возраста

Чтение справочника "Тип бонуса" из r_keeper

GET /api/v0/config/r_keeper/bonus_types/get

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
cached строка запроса boolean Вернуть данные из кэша, без запроса к r_keeper; по умолчанию false

Ответ 200 — массив объектов BonusTypeItemDto:

Поле Тип Обяз. Описание
ident integer да Идентификатор
code integer да Код
name string да Наименование

Проверка связи с r_keeper

GET /api/v0/config/r_keeper/connection/check

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Чтение настроек связи с r_keeper

GET /api/v0/config/r_keeper/connection/get

Авторизация: требуется

Ответ 200 — объект RKeeperConnectionSettingsDto:

Поле Тип Обяз. Описание
address string да Адрес
user string да Пользователь
password string да Пароль

Обновление настроек связи с r_keeper

POST /api/v0/config/r_keeper/connection/update

Авторизация: требуется

Тело запроса — объект RKeeperConnectionSettingsDto:

Поле Тип Обяз. Описание
address string да Адрес
user string да Пользователь
password string да Пароль

Ответ 200 — объект RKeeperConnectionSettingsDto:

Поле Тип Обяз. Описание
address string да Адрес
user string да Пользователь
password string да Пароль

Чтение справочника "Скидки" из r_keeper

GET /api/v0/config/r_keeper/discounts/get

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
cached строка запроса boolean Вернуть данные из кэша, без запроса к r_keeper; по умолчанию false

Ответ 200 — объект DiscountTypeItemDto:

Поле Тип Обяз. Описание
ident integer да Идентификатор
parent integer да
name string да Наименование
children массив любой
isDiscount boolean Скидка (а не бонус); по умолчанию false

Чтение кода "Нулевой скидки"

GET /api/v0/config/r_keeper/extended/get

Авторизация: требуется

Ответ 200 — объект RKeeperExtendedSettingsDto:

Поле Тип Обяз. Описание
defaultDiscountCode integer да Код скидки r_keeper по умолчанию

Обновление кода "Нулевой скидки"

POST /api/v0/config/r_keeper/extended/update

Авторизация: требуется

Тело запроса — объект RKeeperExtendedSettingsDto:

Поле Тип Обяз. Описание
defaultDiscountCode integer да Код скидки r_keeper по умолчанию

Ответ 200 — объект RKeeperExtendedSettingsDto:

Поле Тип Обяз. Описание
defaultDiscountCode integer да Код скидки r_keeper по умолчанию

Чтение справочника "Меню" из r_keeper

GET /api/v0/config/r_keeper/menu_items/get

Авторизация: требуется

Ответ 200 — массив объектов MenuItemDto:

Поле Тип Обяз. Описание
ident integer да Идентификатор
code integer да Код
name string да Наименование
status string да Статус
groupPath string

Чтение настроек реферальной программы

GET /api/v0/config/referral_program/get

Авторизация: требуется

Ответ 200 — объект ReferralProgramConfigGetDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
invitingRewardType ReferralProgramRewardType да Пригласившему: тип вознаграждения (бонусы / купон)
invitingRewardBonusesAmount integer Пригласившему: сумма бонусов
invitingRewardCouponDishId integer Пригласившему: товарный купон
invitingRewardLifetime integer Пригласившему: срок жизни вознаграждения, дней
invitingRewardReceivingCondition ReferralProgramRewardReceivingCondition да Пригласившему: условие получения вознаграждения
getLinkBotBtnText string да Текст кнопки «Получить ссылку» в боте
getLinkText string да Текст сообщения с реферальной ссылкой
invitingInvitedRegisteredText string да Пригласившему: текст «друг зарегистрировался» (бот)
invitingGotRewardText string да Пригласившему: текст «получено вознаграждение» (бот)
walletInvitingInvitedRegisteredText string да Пригласившему: текст «друг зарегистрировался» (Wallet)
walletInvitingGotRewardText string да Пригласившему: текст «получено вознаграждение» (Wallet)
invitedAccountGroupId integer Группа счетов для приглашённых
invitedRewardType ReferralProgramRewardType да Приглашённому: тип вознаграждения
invitedRewardBonusesAmount integer Приглашённому: сумма бонусов
invitedRewardCouponDishId integer Приглашённому: товарный купон
invitedRewardLifetime integer Приглашённому: срок жизни вознаграждения, дней
invitedRewardReceivingCondition ReferralProgramRewardReceivingCondition да Приглашённому: условие получения
invitedRegisteredText string да Приглашённому: текст при регистрации (бот)
invitedGotRewardText string да Приглашённому: текст «получено вознаграждение» (бот)
walletInvitedRegisteredText string да Приглашённому: текст при регистрации (Wallet)
walletInvitedGotRewardText string да Приглашённому: текст «получено вознаграждение» (Wallet)
invitingRewardIsLifetime boolean
invitedRewardIsLifetime boolean

Изменение настроек реферальной программы

POST /api/v0/config/referral_program/update

Авторизация: требуется

Тело запроса — объект ReferralProgramConfigUpdateDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
invitingRewardType ReferralProgramRewardType да Пригласившему: тип вознаграждения (бонусы / купон)
invitingRewardBonusesAmount integer Пригласившему: сумма бонусов
invitingRewardCouponDishId integer Пригласившему: товарный купон
invitingRewardLifetime integer Пригласившему: срок жизни вознаграждения, дней; мин. 1
invitingRewardReceivingCondition ReferralProgramRewardReceivingCondition да Пригласившему: условие получения вознаграждения
getLinkBotBtnText string да Текст кнопки «Получить ссылку» в боте
getLinkText string да Текст сообщения с реферальной ссылкой
invitingInvitedRegisteredText string да Пригласившему: текст «друг зарегистрировался» (бот)
invitingGotRewardText string да Пригласившему: текст «получено вознаграждение» (бот)
walletInvitingInvitedRegisteredText string да Пригласившему: текст «друг зарегистрировался» (Wallet)
walletInvitingGotRewardText string да Пригласившему: текст «получено вознаграждение» (Wallet)
invitedAccountGroupId integer Группа счетов для приглашённых
invitedRewardType ReferralProgramRewardType да Приглашённому: тип вознаграждения
invitedRewardBonusesAmount integer Приглашённому: сумма бонусов
invitedRewardCouponDishId integer Приглашённому: товарный купон
invitedRewardLifetime integer Приглашённому: срок жизни вознаграждения, дней; мин. 1
invitedRewardReceivingCondition ReferralProgramRewardReceivingCondition да Приглашённому: условие получения
invitedRegisteredText string да Приглашённому: текст при регистрации (бот)
invitedGotRewardText string да Приглашённому: текст «получено вознаграждение» (бот)
walletInvitedRegisteredText string да Приглашённому: текст при регистрации (Wallet)
walletInvitedGotRewardText string да Приглашённому: текст «получено вознаграждение» (Wallet)

Ответ 200 — объект ReferralProgramConfigGetDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
invitingRewardType ReferralProgramRewardType да Пригласившему: тип вознаграждения (бонусы / купон)
invitingRewardBonusesAmount integer Пригласившему: сумма бонусов
invitingRewardCouponDishId integer Пригласившему: товарный купон
invitingRewardLifetime integer Пригласившему: срок жизни вознаграждения, дней
invitingRewardReceivingCondition ReferralProgramRewardReceivingCondition да Пригласившему: условие получения вознаграждения
getLinkBotBtnText string да Текст кнопки «Получить ссылку» в боте
getLinkText string да Текст сообщения с реферальной ссылкой
invitingInvitedRegisteredText string да Пригласившему: текст «друг зарегистрировался» (бот)
invitingGotRewardText string да Пригласившему: текст «получено вознаграждение» (бот)
walletInvitingInvitedRegisteredText string да Пригласившему: текст «друг зарегистрировался» (Wallet)
walletInvitingGotRewardText string да Пригласившему: текст «получено вознаграждение» (Wallet)
invitedAccountGroupId integer Группа счетов для приглашённых
invitedRewardType ReferralProgramRewardType да Приглашённому: тип вознаграждения
invitedRewardBonusesAmount integer Приглашённому: сумма бонусов
invitedRewardCouponDishId integer Приглашённому: товарный купон
invitedRewardLifetime integer Приглашённому: срок жизни вознаграждения, дней
invitedRewardReceivingCondition ReferralProgramRewardReceivingCondition да Приглашённому: условие получения
invitedRegisteredText string да Приглашённому: текст при регистрации (бот)
invitedGotRewardText string да Приглашённому: текст «получено вознаграждение» (бот)
walletInvitedRegisteredText string да Приглашённому: текст при регистрации (Wallet)
walletInvitedGotRewardText string да Приглашённому: текст «получено вознаграждение» (Wallet)
invitingRewardIsLifetime boolean
invitedRewardIsLifetime boolean

Чтение настроек сервера Probonus

GET /api/v0/config/server/get

Авторизация: требуется

Ответ 200 — объект ServerSettingsBaseDto:

Поле Тип Обяз. Описание
ipAddress string да IP-адрес
port integer да Порт
reportsTimeout integer да Тайм-аут отчётов, секунд
dbPoolSize integer да Размер пула подключений к БД
httpThreadpoolSize integer да Размер пула HTTP-потоков
accessTokenValidMinutes integer да Срок действия токена доступа, минут
refreshTokenValidMinutes integer да Срок действия токена обновления, минут
logLevel integer да Уровень журналирования
logRetentionDays integer да Срок хранения журналов, дней
telegramProxyPort integer Порт прокси для Telegram
telegramProxyPortCustom boolean Пользовательский порт прокси для Telegram; по умолчанию false

Обновление настроек сервера Probonus

POST /api/v0/config/server/update

Авторизация: требуется

Тело запроса — объект ServerSettingsBaseDto:

Поле Тип Обяз. Описание
ipAddress string да IP-адрес
port integer да Порт
reportsTimeout integer да Тайм-аут отчётов, секунд
dbPoolSize integer да Размер пула подключений к БД
httpThreadpoolSize integer да Размер пула HTTP-потоков
accessTokenValidMinutes integer да Срок действия токена доступа, минут
refreshTokenValidMinutes integer да Срок действия токена обновления, минут
logLevel integer да Уровень журналирования
logRetentionDays integer да Срок хранения журналов, дней
telegramProxyPort integer Порт прокси для Telegram
telegramProxyPortCustom boolean Пользовательский порт прокси для Telegram; по умолчанию false

Ответ 200 — объект ServerSettingsDto:

Поле Тип Обяз. Описание
ipAddress string да IP-адрес
port integer да Порт
reportsTimeout integer да Тайм-аут отчётов, секунд
dbPoolSize integer да Размер пула подключений к БД
httpThreadpoolSize integer да Размер пула HTTP-потоков
accessTokenValidMinutes integer да Срок действия токена доступа, минут
refreshTokenValidMinutes integer да Срок действия токена обновления, минут
logLevel integer да Уровень журналирования
logRetentionDays integer да Срок хранения журналов, дней
telegramProxyPort integer Порт прокси для Telegram
telegramProxyPortCustom boolean Пользовательский порт прокси для Telegram; по умолчанию false
needResetApp boolean по умолчанию false

Чтение настроек Telegram-бота

GET /api/v0/config/telegram_bot/get

Авторизация: требуется

Ответ 200 — объект TelegramBotSettingsGetDto:

Поле Тип Обяз. Описание
config TelegramBotFullConfigGetDto да Настройки
phrases object да Настраиваемые фразы бота

Информация о Telegram-боте по токену

GET /api/v0/config/telegram_bot/get_bot_info

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
token строка запроса string да Токен

Ответ 200 — объект Bot:

Поле Тип Обяз. Описание
username string да Имя пользователя

Список настраиваемых фраз Telegram-бота

GET /api/v0/config/telegram_bot/get_phrases_meta

Авторизация: требуется

Ответ 200 — object.

Импорт настроек Telegram-бота из файла

POST /api/v0/config/telegram_bot/import_config

Авторизация: требуется

Тело запроса (multipart/form-data) — объект Body_telegram_bot_import_config_api_v0_config_telegram_bot_import_config_post:

Поле Тип Обяз. Описание
config_file файл да

Ответ 200 — объект TelegramBotSettingsGetDto:

Поле Тип Обяз. Описание
config TelegramBotFullConfigGetDto да Настройки
phrases object да Настраиваемые фразы бота

Импорт описания и политик Telegram-бота из файла

POST /api/v0/config/telegram_bot/import_description_and_politics

Авторизация: требуется

Тело запроса (multipart/form-data) — объект Body_telegram_bot_import_description_and_politics_api_v0_config_telegram_bot_import_description_and_politics_post:

Поле Тип Обяз. Описание
description_and_politics_file файл да

Ответ 200 — объект TelegramBotSettingsGetDto:

Поле Тип Обяз. Описание
config TelegramBotFullConfigGetDto да Настройки
phrases object да Настраиваемые фразы бота

Изменение настроек Telegram-бота

POST /api/v0/config/telegram_bot/update

Авторизация: требуется

Тело запроса — объект TelegramBotSettingsUpdateDto:

Поле Тип Обяз. Описание
config TelegramBotFullConfigUpdateDto да Настройки
phrases object да Настраиваемые фразы бота

Ответ 200 — объект TelegramBotSettingsGetDto:

Поле Тип Обяз. Описание
config TelegramBotFullConfigGetDto да Настройки
phrases object да Настраиваемые фразы бота

Чтение шаблона карты Wallet

GET /api/v0/config/wallet/card_templates/get

Авторизация: требуется

Параметры запроса:

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — объект WalletCardTemplateDto:

Поле Тип Обяз. Описание
name string да Наименование
organizationName string да Название организации
description string да Описание
iconImg string да Иконка (base64)
logoImg string да Логотип (base64)
stripImg string да Изображение-полоса (base64)
headerContent string да Значение поля в заголовке
secondaryLeftContent string да Значение левого вторичного поля
secondaryRightContent string да Значение правого вторичного поля
headerLabel string да Подпись поля в заголовке
secondaryLeftLabel string да Подпись левого вторичного поля
secondaryRightLabel string да Подпись правого вторичного поля
backText string Текст оборотной стороны
backgroundColor string да Цвет фона (#RRGGBB)
labelColor string да Цвет подписей
foregroundColor string да Цвет текста
sharingProhibited boolean да Запретить передачу карты
id integer да Идентификатор

Добавление шаблона карты Wallet

POST /api/v0/config/wallet/card_templates/insert

Авторизация: требуется

Тело запроса — объект WalletCardTemplateInsertDto:

Поле Тип Обяз. Описание
name string да Наименование
organizationName string да Название организации
description string да Описание
iconImg string да Иконка (base64)
logoImg string да Логотип (base64)
stripImg string да Изображение-полоса (base64)
headerContent string да Значение поля в заголовке
secondaryLeftContent string да Значение левого вторичного поля
secondaryRightContent string да Значение правого вторичного поля
headerLabel string да Подпись поля в заголовке
secondaryLeftLabel string да Подпись левого вторичного поля
secondaryRightLabel string да Подпись правого вторичного поля
backText string Текст оборотной стороны
backgroundColor string да Цвет фона (#RRGGBB)
labelColor string да Цвет подписей
foregroundColor string да Цвет текста
sharingProhibited boolean да Запретить передачу карты

Ответ 200 — объект WalletCardTemplateDto:

Поле Тип Обяз. Описание
name string да Наименование
organizationName string да Название организации
description string да Описание
iconImg string да Иконка (base64)
logoImg string да Логотип (base64)
stripImg string да Изображение-полоса (base64)
headerContent string да Значение поля в заголовке
secondaryLeftContent string да Значение левого вторичного поля
secondaryRightContent string да Значение правого вторичного поля
headerLabel string да Подпись поля в заголовке
secondaryLeftLabel string да Подпись левого вторичного поля
secondaryRightLabel string да Подпись правого вторичного поля
backText string Текст оборотной стороны
backgroundColor string да Цвет фона (#RRGGBB)
labelColor string да Цвет подписей
foregroundColor string да Цвет текста
sharingProhibited boolean да Запретить передачу карты
id integer да Идентификатор

Список шаблонов карт Wallet

GET /api/v0/config/wallet/card_templates/list

Авторизация: требуется

Ответ 200 — массив объектов WalletCardTemplateListDto:

Поле Тип Обяз. Описание
id integer да Идентификатор
name string да Наименование

Изменение шаблона карты Wallet

POST /api/v0/config/wallet/card_templates/update

Авторизация: требуется

Тело запроса — объект WalletCardTemplateUpdateDto:

Поле Тип Обяз. Описание
name string да Наименование
organizationName string да Название организации
description string да Описание
iconImg string да Иконка (base64)
logoImg string да Логотип (base64)
stripImg string да Изображение-полоса (base64)
headerContent string да Значение поля в заголовке
secondaryLeftContent string да Значение левого вторичного поля
secondaryRightContent string да Значение правого вторичного поля
headerLabel string да Подпись поля в заголовке
secondaryLeftLabel string да Подпись левого вторичного поля
secondaryRightLabel string да Подпись правого вторичного поля
backText string Текст оборотной стороны
backgroundColor string да Цвет фона (#RRGGBB)
labelColor string да Цвет подписей
foregroundColor string да Цвет текста
sharingProhibited boolean да Запретить передачу карты
id integer да Идентификатор

Ответ 200 — объект WalletCardTemplateDto:

Поле Тип Обяз. Описание
name string да Наименование
organizationName string да Название организации
description string да Описание
iconImg string да Иконка (base64)
logoImg string да Логотип (base64)
stripImg string да Изображение-полоса (base64)
headerContent string да Значение поля в заголовке
secondaryLeftContent string да Значение левого вторичного поля
secondaryRightContent string да Значение правого вторичного поля
headerLabel string да Подпись поля в заголовке
secondaryLeftLabel string да Подпись левого вторичного поля
secondaryRightLabel string да Подпись правого вторичного поля
backText string Текст оборотной стороны
backgroundColor string да Цвет фона (#RRGGBB)
labelColor string да Цвет подписей
foregroundColor string да Цвет текста
sharingProhibited boolean да Запретить передачу карты
id integer да Идентификатор

Чтение геолокаций Wallet

GET /api/v0/config/wallet/locations/get

Авторизация: требуется

Ответ 200 — массив объектов WalletLocationsListItemDto:

Поле Тип Обяз. Описание
name string да Наименование
latitude number да Широта
longitude number да Долгота
relevantText string да Текст, показываемый рядом с точкой

Изменение геолокаций Wallet

POST /api/v0/config/wallet/locations/update

Авторизация: требуется

Тело запроса — массив объектов WalletLocationsListItemDto:

Поле Тип Обяз. Описание
name string да Наименование
latitude number да Широта
longitude number да Долгота
relevantText string да Текст, показываемый рядом с точкой

Ответ 200 — массив объектов WalletLocationsListItemDto:

Поле Тип Обяз. Описание
name string да Наименование
latitude number да Широта
longitude number да Долгота
relevantText string да Текст, показываемый рядом с точкой

Чтение настроек формы гостя Wallet

GET /api/v0/config/wallet_guest_form/get

Авторизация: требуется

Ответ 200 — объект WalletGuestFormConfigGetDto:

Поле Тип Обяз. Описание
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
form WalletFormGetDto да Форма
defaultRegistrationUrl string (URL)(2083) Ссылка на регистрацию по умолчанию; мин. длина 1
utms массив UtmSettingsGetDto да UTM-метки
cardDownloadForm WalletCardDownloadFormDto да Форма загрузки карты

Изменение настроек формы гостя Wallet

POST /api/v0/config/wallet_guest_form/update

Авторизация: требуется

Тело запроса — объект WalletGuestFormConfigUpdateDto:

Поле Тип Обяз. Описание
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
form WalletFormUpdateDto да Форма
utms массив UtmSettingsUpdateDto да UTM-метки
cardDownloadForm WalletCardDownloadFormDto да Форма загрузки карты

Ответ 200 — объект WalletGuestFormConfigGetDto:

Поле Тип Обяз. Описание
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
form WalletFormGetDto да Форма
defaultRegistrationUrl string (URL)(2083) Ссылка на регистрацию по умолчанию; мин. длина 1
utms массив UtmSettingsGetDto да UTM-метки
cardDownloadForm WalletCardDownloadFormDto да Форма загрузки карты

Чтение основных настроек Wallet

GET /api/v0/config/wallet_main/get

Авторизация: требуется

Ответ 200 — объект WalletMainConfigGetDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
useDynamicCode boolean да Использовать динамический код
applePassTypeIdentifier string
appleTeamIdentifier string
wwdrCommonName string
wwdrOrganizationalUnit string
isCertPasswordSaved boolean да
isWalletCertDownloaded boolean да
walletCertExpirationDate date
isWalletCertPrivateKeyDownloaded boolean да
isWwdrCertDownloaded boolean да
wwdrCertExpirationDate date

Изменение основных настроек Wallet

POST /api/v0/config/wallet_main/update

Авторизация: требуется

Тело запроса — объект WalletMainConfigUpdateDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
useDynamicCode boolean да Использовать динамический код
walletCertP12 string
wwdrCert string
certPassword string

Ответ 200 — объект WalletMainConfigGetDto:

Поле Тип Обяз. Описание
enabled boolean да Включено
useDynamicCode boolean да Использовать динамический код
applePassTypeIdentifier string
appleTeamIdentifier string
wwdrCommonName string
wwdrOrganizationalUnit string
isCertPasswordSaved boolean да
isWalletCertDownloaded boolean да
walletCertExpirationDate date
isWalletCertPrivateKeyDownloaded boolean да
isWwdrCertDownloaded boolean да
wwdrCertExpirationDate date

Модели данных

Вложенные объекты и перечисления, на которые ссылаются методы этого раздела.

AntiFraudEmailItemDto

Поле Тип Обяз. Описание
email string да Адрес e-mail

AntiFraudRestaurantReceiverDto

Поле Тип Обяз. Описание
userId integer да Идентификатор пользователя
chatId integer да Идентификатор чата
fullName string да ФИО гостя
phone string да Номер телефона
registeredAt datetime да Дата регистрации
isBlocked boolean да Заблокирован

AntiFraudSettingsExceptionsAccountGroupsDto

Поле Тип Обяз. Описание
id integer да Идентификатор
name string да Наименование

AntiFraudSettingsExceptionsAccountsDto

Поле Тип Обяз. Описание
id integer да Идентификатор
fName string(100) Имя
lName string(100) Фамилия
mName string(100) Отчество
draft boolean да Заготовка карты (счёт создан без данных гостя)
isBlocked boolean Заблокирован
cards string Действующие карты
cardsBl string Заблокированые карты
phones string Действующие телефоны
phonesBl string Заблокированые телефоны
identifiers string Действующие идентификаторы (не телефоны, и не карты)
identifiersBl string Заблокированые идентификаторы (не телефоны, и не карты)

AntiFraudSettingsExceptionsGetDto

Поле Тип Обяз. Описание
accounts массив AntiFraudSettingsExceptionsAccountsDto Список счетов
accountGroups массив AntiFraudSettingsExceptionsAccountGroupsDto Группы счетов

AntiFraudSettingsExceptionsUpdateDto

Поле Тип Обяз. Описание
accounts массив integer Список счетов
accountGroups массив integer Группы счетов

CashRegistrationSettingsDto

Поле Тип Обяз. Описание
useVirtualKeyboard boolean да
useLastName boolean да Запрашивать фамилию
requireLastName boolean да Фамилия обязательна
useFirstName boolean да Запрашивать имя
requireFirstName boolean да Имя обязательно
useMiddleName boolean да Запрашивать отчество
requireMiddleName boolean да Отчество обязательно
useSex boolean да Запрашивать пол
requireSex boolean да Пол обязателен
useBirthday boolean да Запрашивать дату рождения
requireBirthday boolean да Дата рождения обязательна
usePhone boolean да Запрашивать телефон
requirePhone boolean да Телефон обязателен
useEmail boolean да Запрашивать e-mail
requireEmail boolean да E-mail обязателен
useAccountGroup boolean да Выбирать группу счетов
requireAccountGroup boolean да Группа счетов обязательна
accountGroupIds массив integer Список идентификаторов групп счетов
useIdentifier boolean да Запрашивать идентификатор
requireIdentifier boolean да Идентификатор обязателен
identifierId integer Идентификатор записи идентификатора
login string да Логин
password string да Пароль

ImagePosition

Перечисление (string). Значения: left, right, top, bottom, top-left, top-right, bottom-left, bottom-right.

MaxBotConfigCustomButtonGetDto

Поле Тип Обяз. Описание
enabled boolean да Включено
name string да Наименование
text string Текст
media string Файлы (изображения)
mediaId integer Идентификатор файла

MaxBotConfigCustomButtonUpdateDto

Поле Тип Обяз. Описание
enabled boolean да Включено
name string да Наименование
text string Текст
media string Файлы (изображения)

MaxBotFullConfigGetDto

Поле Тип Обяз. Описание
description string да Описание
showUserAgreement boolean да Показывать пользовательское соглашение
userAgreementText string Текст пользовательского соглашения
showPrivacyPolicy boolean да Показывать политику конфиденциальности
privacyPolicyText string Текст политики конфиденциальности
ageConfirmationEnabled boolean Запрашивать подтверждение возраста
mailingConfirmationEnabled boolean Запрашивать согласие на рассылки
enabled boolean да Включено
webhookUrl string да Адрес webhook
usePolling boolean да Получать обновления опросом (polling) вместо webhook
allowReviews boolean да Разрешить отзывы
managerChat string да Чат менеджера для уведомлений
allowRegistration boolean да Разрешить регистрацию новых гостей
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
requestBirthday boolean да Запрашивать дату рождения
requestSex boolean да Запрашивать пол
allowMaxName boolean да Использовать имя из профиля MAX
allowRequestAccountReport boolean да Разрешить гостю запрашивать отчёт по счёту
allowRequestBalance boolean да Разрешить гостю запрашивать баланс
allowRequestTemporaryCode boolean да Разрешить гостю запрашивать временный код
redirectReview RedirectReviewType да Перенаправлять отзывы на сторонние ресурсы
redirectReviewText string Текст перенаправления отзыва
temporaryCodeDesignEnabled boolean да Собственное оформление временного кода
temporaryCodeColorBackground string да Цвет фона временного кода
threadpoolSize integer да Размер пула потоков
customButton1 MaxBotConfigCustomButtonGetDto да Пользовательская кнопка 1
customButton2 MaxBotConfigCustomButtonGetDto да Пользовательская кнопка 2
customButton3 MaxBotConfigCustomButtonGetDto да Пользовательская кнопка 3
customButton4 MaxBotConfigCustomButtonGetDto да Пользовательская кнопка 4
temporaryCodeMediaLogoId integer Идентификатор файла логотипа временного кода
temporaryCodeMediaLogo string Логотип для временного кода
defaultRegistrationUrl string (URL)(2083) Ссылка на регистрацию по умолчанию; мин. длина 1
utms массив MaxBotUtmSettingsGetDto да UTM-метки
isTokenSaved boolean да

MaxBotFullConfigUpdateDto

Поле Тип Обяз. Описание
description string да Описание
showUserAgreement boolean да Показывать пользовательское соглашение
userAgreementText string Текст пользовательского соглашения
showPrivacyPolicy boolean да Показывать политику конфиденциальности
privacyPolicyText string Текст политики конфиденциальности
ageConfirmationEnabled boolean Запрашивать подтверждение возраста
mailingConfirmationEnabled boolean Запрашивать согласие на рассылки
enabled boolean да Включено
webhookUrl string да Адрес webhook
usePolling boolean да Получать обновления опросом (polling) вместо webhook
allowReviews boolean да Разрешить отзывы
managerChat string да Чат менеджера для уведомлений
allowRegistration boolean да Разрешить регистрацию новых гостей
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
requestBirthday boolean да Запрашивать дату рождения
requestSex boolean да Запрашивать пол
allowMaxName boolean да Использовать имя из профиля MAX
utms массив MaxBotUtmSettingsUpdateDto да UTM-метки
token string
allowRequestAccountReport boolean да Разрешить гостю запрашивать отчёт по счёту
allowRequestBalance boolean да Разрешить гостю запрашивать баланс
allowRequestTemporaryCode boolean да Разрешить гостю запрашивать временный код
redirectReview RedirectReviewType да Перенаправлять отзывы на сторонние ресурсы
redirectReviewText string Текст перенаправления отзыва
temporaryCodeDesignEnabled boolean да Собственное оформление временного кода
temporaryCodeColorBackground string да Цвет фона временного кода
threadpoolSize integer да Размер пула потоков
customButton1 MaxBotConfigCustomButtonUpdateDto да Пользовательская кнопка 1
customButton2 MaxBotConfigCustomButtonUpdateDto да Пользовательская кнопка 2
customButton3 MaxBotConfigCustomButtonUpdateDto да Пользовательская кнопка 3
customButton4 MaxBotConfigCustomButtonUpdateDto да Пользовательская кнопка 4
temporaryCodeMediaLogo string Логотип для временного кода

MaxBotUtmSettingsGetDto

Поле Тип Обяз. Описание
utm string да
accountGroupId integer да Идентификатор группы счетов
registrationUrl string (URL)(2083) Ссылка на регистрацию; мин. длина 1

MaxBotUtmSettingsUpdateDto

Поле Тип Обяз. Описание
utm string да
accountGroupId integer да Идентификатор группы счетов

RedirectReviewType

Перечисление (integer). Значения: 1, 2, 3.

ReferralProgramRewardReceivingCondition

Перечисление (integer). Значения: 1, 2.

ReferralProgramRewardType

Перечисление (integer). Значения: 1, 2, 3.

SpecialCasesDto

Поле Тип Обяз. Описание
mealsWithSubsidies boolean да
loyaltyParticipants boolean да

TelegramBotConfigCustomButtonGetDto

Поле Тип Обяз. Описание
enabled boolean да Включено
name string да Наименование
text string Текст
media string Файлы (изображения)
mediaId integer Идентификатор файла

TelegramBotConfigCustomButtonUpdateDto

Поле Тип Обяз. Описание
enabled boolean да Включено
name string да Наименование
text string Текст
media string Файлы (изображения)

TelegramBotFullConfigGetDto

Поле Тип Обяз. Описание
description string да Описание
showPersonalInformationPolicy boolean да Показывать политику обработки персональных данных
personalInformationPolicyText string да Текст политики обработки персональных данных
showPrivacyPolicy boolean да Показывать политику конфиденциальности
privacyPolicyText string да Текст политики конфиденциальности
ageConfirmationEnabled boolean Запрашивать подтверждение возраста
mailingConfirmationEnabled boolean Запрашивать согласие на рассылки
enabled boolean да Включено
allowReviews boolean да Разрешить отзывы
managerChat string да Чат менеджера для уведомлений
allowRegistration boolean да Разрешить регистрацию новых гостей
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
requestBirthday boolean да Запрашивать дату рождения
requestSex boolean да Запрашивать пол
allowTelegramName boolean да Использовать имя из профиля Telegram
allowRequestAccountReport boolean да Разрешить гостю запрашивать отчёт по счёту
allowRequestBalance boolean да Разрешить гостю запрашивать баланс
allowRequestTemporaryCode boolean да Разрешить гостю запрашивать временный код
redirectReview RedirectReviewType да Перенаправлять отзывы на сторонние ресурсы
redirectReviewText string Текст перенаправления отзыва
temporaryCodeDesignEnabled boolean да Собственное оформление временного кода
temporaryCodeColorBackground string да Цвет фона временного кода
threadpoolSize integer да Размер пула потоков
customButton1 TelegramBotConfigCustomButtonGetDto да Пользовательская кнопка 1
customButton2 TelegramBotConfigCustomButtonGetDto да Пользовательская кнопка 2
customButton3 TelegramBotConfigCustomButtonGetDto да Пользовательская кнопка 3
customButton4 TelegramBotConfigCustomButtonGetDto да Пользовательская кнопка 4
temporaryCodeMediaLogoId integer Идентификатор файла логотипа временного кода
temporaryCodeMediaLogo string Логотип для временного кода
defaultRegistrationUrl string (URL)(2083) Ссылка на регистрацию по умолчанию; мин. длина 1
utms массив UtmSettingsGetDto да UTM-метки
isTokenSaved boolean да
telegramApiBaseUrl string Адрес API Telegram

TelegramBotFullConfigUpdateDto

Поле Тип Обяз. Описание
description string да Описание
showPersonalInformationPolicy boolean да Показывать политику обработки персональных данных
personalInformationPolicyText string да Текст политики обработки персональных данных
showPrivacyPolicy boolean да Показывать политику конфиденциальности
privacyPolicyText string да Текст политики конфиденциальности
ageConfirmationEnabled boolean Запрашивать подтверждение возраста
mailingConfirmationEnabled boolean Запрашивать согласие на рассылки
enabled boolean да Включено
allowReviews boolean да Разрешить отзывы
managerChat string да Чат менеджера для уведомлений
allowRegistration boolean да Разрешить регистрацию новых гостей
defaultAccountGroupId integer да Группа счетов по умолчанию для новых гостей
requestBirthday boolean да Запрашивать дату рождения
requestSex boolean да Запрашивать пол
allowTelegramName boolean да Использовать имя из профиля Telegram
utms массив UtmSettingsUpdateDto да UTM-метки
token string
telegramApiBaseUrl string Адрес API Telegram
allowRequestAccountReport boolean да Разрешить гостю запрашивать отчёт по счёту
allowRequestBalance boolean да Разрешить гостю запрашивать баланс
allowRequestTemporaryCode boolean да Разрешить гостю запрашивать временный код
redirectReview RedirectReviewType да Перенаправлять отзывы на сторонние ресурсы
redirectReviewText string Текст перенаправления отзыва
temporaryCodeDesignEnabled boolean да Собственное оформление временного кода
temporaryCodeColorBackground string да Цвет фона временного кода
threadpoolSize integer да Размер пула потоков
customButton1 TelegramBotConfigCustomButtonUpdateDto да Пользовательская кнопка 1
customButton2 TelegramBotConfigCustomButtonUpdateDto да Пользовательская кнопка 2
customButton3 TelegramBotConfigCustomButtonUpdateDto да Пользовательская кнопка 3
customButton4 TelegramBotConfigCustomButtonUpdateDto да Пользовательская кнопка 4
temporaryCodeMediaLogo string Логотип для временного кода

UtmSettingsGetDto

Поле Тип Обяз. Описание
utm string да
accountGroupId integer да Идентификатор группы счетов
registrationUrl string (URL)(2083) Ссылка на регистрацию; мин. длина 1

UtmSettingsUpdateDto

Поле Тип Обяз. Описание
utm string да
accountGroupId integer да Идентификатор группы счетов

WalletCardDownloadFormButtonDto

Поле Тип Обяз. Описание
caption string да Подпись
url string да Адрес (URL)

WalletCardDownloadFormDto

Поле Тип Обяз. Описание
textAndroidUsers string
buttons массив WalletCardDownloadFormButtonDto да

WalletFormGetDto

Поле Тип Обяз. Описание
requireFirstName boolean да Имя обязательно
useMiddleName boolean да Запрашивать отчество
requireMiddleName boolean да Отчество обязательно
useSex boolean да Запрашивать пол
requireSex boolean да Пол обязателен
useBirthday boolean да Запрашивать дату рождения
useEmail boolean да Запрашивать e-mail
requireEmail boolean да E-mail обязателен
useAgeConfirmation boolean да Запрашивать подтверждение возраста
ageConfirmationText string Текст подтверждения возраста
useMailingConfirmation boolean да Запрашивать согласие на рассылки
mailingConfirmationText string Текст согласия на рассылки
usePersonalInformationPolicy boolean да Запрашивать согласие с политикой обработки ПД
usePersonalInformationPolicyLabel string Подпись согласия с политикой обработки ПД
personalInformationPolicyText string Текст политики обработки персональных данных
usePrivacyPolicy boolean да Запрашивать согласие с политикой конфиденциальности
usePrivacyPolicyLabel string Подпись согласия с политикой конфиденциальности
privacyPolicyText string Текст политики конфиденциальности
colorBackground string Цвет фона
colorTextBorder string Цвет текста и рамки
colorButton string Цвет кнопки
mediaLogo string Логотип
mediaBackground string Фоновое изображение
mediaLogoId integer Идентификатор файла логотипа
mediaBackgroundId integer Идентификатор файла фона

WalletFormUpdateDto

Поле Тип Обяз. Описание
requireFirstName boolean да Имя обязательно
useMiddleName boolean да Запрашивать отчество
requireMiddleName boolean да Отчество обязательно
useSex boolean да Запрашивать пол
requireSex boolean да Пол обязателен
useBirthday boolean да Запрашивать дату рождения
useEmail boolean да Запрашивать e-mail
requireEmail boolean да E-mail обязателен
useAgeConfirmation boolean да Запрашивать подтверждение возраста
ageConfirmationText string Текст подтверждения возраста
useMailingConfirmation boolean да Запрашивать согласие на рассылки
mailingConfirmationText string Текст согласия на рассылки
usePersonalInformationPolicy boolean да Запрашивать согласие с политикой обработки ПД
usePersonalInformationPolicyLabel string Подпись согласия с политикой обработки ПД
personalInformationPolicyText string Текст политики обработки персональных данных
usePrivacyPolicy boolean да Запрашивать согласие с политикой конфиденциальности
usePrivacyPolicyLabel string Подпись согласия с политикой конфиденциальности
privacyPolicyText string Текст политики конфиденциальности
colorBackground string Цвет фона
colorTextBorder string Цвет текста и рамки
colorButton string Цвет кнопки
mediaLogo string Логотип
mediaBackground string Фоновое изображение
  • external/pro_bonus/10_probonus_api/08_config.1792495268.txt.gz
  • Последнее изменение: 2026/10/20 14:21
  • — Алексей Коробов