====== ProBonus API. Справочник методов ======
ProBonus предоставляет REST API (JSON over HTTP) для интеграции с внешними системами: сайтом и мобильным приложением, службой доставки, CRM, системами отчётности. Общее описание API и типовые сценарии — в статьях [[external:pro_bonus:10_probonus_api|ProBonus Api]] и [[external:pro_bonus:10_probonus_api:55_primer|Типовые сценарии]].
Справочник построен по OpenAPI-схеме сервера ProBonus версии **65535.2.86.411** и содержит **285 методов** в 8 разделах. Набор методов и полей зависит от версии ProBonus: актуальное описание для вашего сервера всегда доступно в интерактивной документации (Swagger) по адресу ''http://<сервер>:<порт>/docs'' или во вкладке «ProBonus API» веб-интерфейса.
===== Подключение =====
* **Адрес:** ''http://<сервер ProBonus>:<порт>'' — тот же адрес и порт, что и у веб-интерфейса ProBonus.
* **Формат:** запросы и ответы — JSON в кодировке UTF-8 (заголовок ''Content-Type: application/json''). Загрузка файлов — ''multipart/form-data''.
* **Методы HTTP:** чтение данных — ''GET'' с параметрами в строке запроса; добавление, изменение, удаление и операции — ''POST'' с телом запроса в JSON.
* **Версии API:** основная часть методов — ''/api/v0/...''. Сегментные акции в актуальном формате (акция с несколькими действиями) — ''/api/v1/promotions/...''; методы ''/api/v0/promotions/...'' сохранены для совместимости.
===== Авторизация =====
Все методы, кроме отмеченных «Авторизация: не требуется», требуют авторизации одним из двух способов.
==== Токен пользователя (Bearer) ====
Используется веб-интерфейсом и подходит для интерактивных приложений.
- Получите токен методом ''POST /api/v0/auth/login'', передав логин и пароль пользователя ProBonus:
{ "login": "api_user", "password": "********" }
- В ответе придут ''accessToken'', срок его действия ''expire'' и ''refreshToken''.
- Передавайте токен во всех запросах в заголовке:
Authorization: Bearer
- До истечения срока действия получите новую пару токенов методом ''POST /api/v0/auth/refresh_token''. Сроки действия токенов задаются в настройках сервера (''accessTokenValidMinutes'', ''refreshTokenValidMinutes'').
==== Ключ API (X-API-Key) ====
Рекомендуемый способ для интеграций с внешними системами (доступен с версии ProBonus 1.2.60.297). Создайте в веб-интерфейсе [[external:pro_bonus:03_probonus_work:01_webadmin:01_users#пользователь_для_api|пользователя для API]] (или методом ''POST /api/v0/users/insert_api_user'') и передавайте его бессрочный токен в заголовке:
X-API-Key: <токен пользователя API>
**Важно!** Права пользователя API ограничиваются его ролью: роль содержит перечень разрешённых методов (см. [[external:pro_bonus:03_probonus_work:01_webadmin:012_roles|Роли]]). При вызове метода, не разрешённого ролью, сервер вернёт ответ ''403''. Выдавайте пользователю API только те методы, которые нужны интеграции.
===== Соглашения =====
* **Имена полей** в JSON — в стиле camelCase (''accountGroupId''), имена query-параметров — в стиле snake_case (''account_group_id'').
* **Суммы** с типом ''number'' передаются в **рублях** с копейками в дробной части (например, ''150.50''). Обратите внимание: в базе данных те же суммы хранятся в копейках.
* **Даты** — строки в формате ISO 8601: дата ''2026-10-01'', дата и время ''2026-10-01T12:30:00''.
* **Списочные параметры** (например, ''account_group_ids'') передаются повторением параметра: ''?account_group_ids=1&account_group_ids=5''.
* **Удаление** объектов справочников, как правило, мягкое: объект помечается удалённым и может быть восстановлен (методы ''restore'').
* **Обязательные поля** отмечены в таблицах знаком «да» в колонке «Обяз.». Необязательные поля можно не передавать или передавать ''null''.
===== Коды ответов и ошибки =====
^ Код ^ Значение ^ Тело ответа ^
| ''200'' | Успешно | Результат (описан у каждого метода) |
| ''202'' | Запрос принят, выполняется в фоне | Идентификатор задачи |
| ''204'' | Успешно, без содержимого | — |
| ''400'' | Ошибка в данных запроса (бизнес-логика) | Массив ''ResponseErrorItem'' |
| ''401'' | Неверный логин/пароль или токен | Массив ''ResponseErrorItem'' |
| ''403'' | Нет прав на метод или объект | Массив ''ResponseErrorItem'' |
| ''410'' | Объект больше недоступен (удалён, истёк) | Массив ''ResponseErrorItem'' |
| ''422'' | Ошибка валидации (не тот тип, нет обязательного поля) | ''HTTPValidationError'' |
| ''500'' | Внутренняя ошибка сервера | ''Response500Error'' |
Формат ошибок:
// 400, 401, 403, 410 — массив ошибок
[ { "code": "ACCOUNT_NOT_FOUND", "message": "Счёт не найден" } ]
// 422 — ошибка валидации
{ "detail": [ { "loc": ["body", "amount"], "msg": "field required", "type": "value_error.missing" } ] }
// 500 — внутренняя ошибка
{ "class_name": "Exception", "message": "..." }
Коды и тексты ошибок в примере условные — сервер возвращает собственные значения.
===== Пример: пополнение баланса гостя =====
# 1. Найти счёт по номеру телефона
curl -H "X-API-Key: <токен>" "http://probonus:11030/api/v0/accounts/find_by_phone?phone=79991234567"
# 2. Пополнить баланс найденного счёта на 100 руб. с отложенным на 1 день начислением
curl -X POST -H "X-API-Key: <токен>" -H "Content-Type: application/json" \
-d '{"id": 123, "amount": 100, "reason": "Компенсация", "lateIssueDays": 1}' \
"http://probonus:11030/api/v0/accounts/refill"
===== Разделы справочника =====
^ Раздел ^ Методов ^ Содержание ^
| [[external:pro_bonus:10_probonus_api:01_auth|Авторизация, лицензия и пользователи]] | 19 | Получение и обновление токена, информация о лицензии, управление пользователями веб-интерфейса и API, роли и права. |
| [[external:pro_bonus:10_probonus_api:02_accounts|Счета гостей]] | 58 | Поиск, создание и изменение счетов гостей, баланс, пополнение и изъятие, транзакции, теги, купоны, штампики, групповые операции, контакты в мессенджерах. |
| [[external:pro_bonus:10_probonus_api:03_dictionaries|Справочники]] | 38 | Группы счетов, составные скидки, типы идентификаторов, рестораны, теги и группы тегов, товарные купоны. |
| [[external:pro_bonus:10_probonus_api:04_promotions|Акции и сегменты]] | 47 | Сегментные акции (v1 и устаревшая v0), триггерные акции, «Штампики N+1», промокоды, сегменты гостей. |
| [[external:pro_bonus:10_probonus_api:05_communications|Рассылки, отзывы и Wallet]] | 16 | Отправка сообщений гостям, загрузка файлов, работа с отзывами, баланс и транзакции для карт Wallet. |
| [[external:pro_bonus:10_probonus_api:06_reports|Отчёты]] | 34 | Методы, формирующие отчёты веб-интерфейса, и получение содержимого чека. |
| [[external:pro_bonus:10_probonus_api:07_integration|Внешние продажи, импорт и инфокиоск]] | 10 | Регистрация продаж из внешних систем (не r_keeper), импорт счетов и потрат, страницы инфокиоска. |
| [[external:pro_bonus:10_probonus_api:08_config|Настройки сервера]] | 63 | Чтение и изменение настроек ProBonus: БД, связь с r_keeper, антифрод, боты, Wallet, рассылки, политики, реферальная программа, ИИ. |
===== Все методы =====
==== Авторизация, лицензия и пользователи ====
^ Метод ^ Адрес ^ Назначение ^
| ''GET'' | ''/api/v0/auth/info'' | [[external:pro_bonus:10_probonus_api:01_auth#получение_информации_о_лицензии_и_настройках_сервера_probonus|Получение информации о лицензии и настройках сервера ProBonus]] |
| ''POST'' | ''/api/v0/auth/login'' | [[external:pro_bonus:10_probonus_api:01_auth#получение_токена_авторизации_на_основании_логина_и_пароля|Получение токена авторизации (на основании логина и пароля)]] |
| ''POST'' | ''/api/v0/auth/logout'' | [[external:pro_bonus:10_probonus_api:01_auth#выход_пользователя_из_системы|Выход пользователя из системы]] |
| ''POST'' | ''/api/v0/auth/refresh_token'' | [[external:pro_bonus:10_probonus_api:01_auth#обновление_токена_авторизации|Обновление токена авторизации]] |
| ''GET'' | ''/api/v0/license/check_license'' | [[external:pro_bonus:10_probonus_api:01_auth#принудительное_обновление_информации_о_лицензии_с_сервера_лицензирования|Принудительное обновление информации о лицензии с сервера лицензирования]] |
| ''GET'' | ''/api/v0/license/info'' | [[external:pro_bonus:10_probonus_api:01_auth#получение_информации_о_лицензии_на_по_probonus|Получение информации о лицензии на ПО ProBonus]] |
| ''POST'' | ''/api/v0/users/change_password'' | [[external:pro_bonus:10_probonus_api:01_auth#обновление_пароля_для_пользователя_по_заданному_id|Обновление пароля для пользователя по заданному id]] |
| ''POST'' | ''/api/v0/users/delete'' | [[external:pro_bonus:10_probonus_api:01_auth#удаление_пользователя_по_заданному_id|Удаление пользователя по заданному id]] |
| ''GET'' | ''/api/v0/users/get'' | [[external:pro_bonus:10_probonus_api:01_auth#чтение_данных_пользователя_по_заданному_id|Чтение данных пользователя по заданному id]] |
| ''POST'' | ''/api/v0/users/insert'' | [[external:pro_bonus:10_probonus_api:01_auth#добавление_нового_пользователя_insert|Добавление нового пользователя — insert]] |
| ''POST'' | ''/api/v0/users/insert_api_user'' | [[external:pro_bonus:10_probonus_api:01_auth#добавление_нового_пользователя_insert_api_user|Добавление нового пользователя — insert_api_user]] |
| ''GET'' | ''/api/v0/users/list'' | [[external:pro_bonus:10_probonus_api:01_auth#чтение_справочника_пользователи|Чтение справочника "Пользователи"]] |
| ''POST'' | ''/api/v0/users/update'' | [[external:pro_bonus:10_probonus_api:01_auth#изменение_данных_пользователя_по_заданному_id_update|Изменение данных пользователя по заданному id — update]] |
| ''POST'' | ''/api/v0/users/update_api_user'' | [[external:pro_bonus:10_probonus_api:01_auth#изменение_данных_пользователя_по_заданному_id_update_api_user|Изменение данных пользователя по заданному id — update_api_user]] |
| ''POST'' | ''/api/v0/roles/delete'' | [[external:pro_bonus:10_probonus_api:01_auth#удаление_роли|Удаление роли]] |
| ''GET'' | ''/api/v0/roles/get'' | [[external:pro_bonus:10_probonus_api:01_auth#чтение_роли_по_id|Чтение роли по id]] |
| ''POST'' | ''/api/v0/roles/insert'' | [[external:pro_bonus:10_probonus_api:01_auth#добавление_роли|Добавление роли]] |
| ''GET'' | ''/api/v0/roles/list'' | [[external:pro_bonus:10_probonus_api:01_auth#список_ролей|Список ролей]] |
| ''POST'' | ''/api/v0/roles/update'' | [[external:pro_bonus:10_probonus_api:01_auth#изменение_роли|Изменение роли]] |
==== Счета гостей ====
^ Метод ^ Адрес ^ Назначение ^
| ''GET'' | ''/api/v0/accounts/activity_by_periods'' | [[external:pro_bonus:10_probonus_api:02_accounts#краткий_отчёт_активность_по_периодам_день7днейнеделя30днеймесяцвсё_время|Краткий отчёт "Активность по периодам" (день/7дней/неделя/30дней/месяц/всё время)]] |
| ''POST'' | ''/api/v0/accounts/block'' | [[external:pro_bonus:10_probonus_api:02_accounts#блокировка_элемента_справочника_счета_по_заданному_id|Блокировка элемента справочника "Счета" по заданному id]] |
| ''POST'' | ''/api/v0/accounts/coupon_dish_delete'' | [[external:pro_bonus:10_probonus_api:02_accounts#удалить_начисленный_купон|Удалить начисленный купон]] |
| ''POST'' | ''/api/v0/accounts/coupon_dish_issue'' | [[external:pro_bonus:10_probonus_api:02_accounts#начислить_купон_на_счёт|Начислить купон на счёт]] |
| ''POST'' | ''/api/v0/accounts/delete'' | [[external:pro_bonus:10_probonus_api:02_accounts#удаление_элемента_справочника_счета_по_заданному_id|Удаление элемента справочника "Счета" по заданному id]] |
| ''GET'' | ''/api/v0/accounts/find_by_identifier'' | [[external:pro_bonus:10_probonus_api:02_accounts#чтение_элемента_справочника_счета_по_заданному_идентификатору|Чтение элемента справочника "Счета" по заданному идентификатору]] |
| ''GET'' | ''/api/v0/accounts/find_by_phone'' | [[external:pro_bonus:10_probonus_api:02_accounts#чтение_элемента_справочника_счета_по_заданному_номеру_телефона|Чтение элемента справочника "Счета" по заданному номеру телефона]] |
| ''GET'' | ''/api/v0/accounts/find_by_phone_part'' | [[external:pro_bonus:10_probonus_api:02_accounts#поиск_счетов_по_части_номера_телефона|Поиск счетов по части номера телефона]] |
| ''GET'' | ''/api/v0/accounts/get'' | [[external:pro_bonus:10_probonus_api:02_accounts#чтение_элемента_справочника_счета_по_заданному_id|Чтение элемента справочника "Счета" по заданному id]] |
| ''GET'' | ''/api/v0/accounts/get_available_bonuses'' | [[external:pro_bonus:10_probonus_api:02_accounts#баланс_и_сумма_доступная_к_оплате_по_счетам|Баланс и сумма, доступная к оплате, по счетам]] |
| ''GET'' | ''/api/v0/accounts/get_balance_extended'' | [[external:pro_bonus:10_probonus_api:02_accounts#получение_информации_о_балансе_счета_по_заданному_id|Получение информации о балансе счета по заданному id]] |
| ''GET'' | ''/api/v0/accounts/get_last_raw_transactions'' | [[external:pro_bonus:10_probonus_api:02_accounts#последние_транзакции_счёта_без_обработки|Последние транзакции счёта (без обработки)]] |
| ''GET'' | ''/api/v0/accounts/get_temporary_identifier'' | [[external:pro_bonus:10_probonus_api:02_accounts#генерация_временного_идентификатора_для_счета_по_его_id|Генерация временного идентификатора для счета по его id]] |
| ''POST'' | ''/api/v0/accounts/group_operations/account_group_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияперенос_всех_счетов_группы_в_другую_группу|Групповая операция: перенос всех счетов группы в другую группу]] |
| ''POST'' | ''/api/v0/accounts/group_operations/account_group_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциясмена_группы_для_выбранных_счетов|Групповая операция: смена группы для выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/add_draft_cards'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциясоздание_заготовок_карт|Групповая операция: создание заготовок карт]] |
| ''POST'' | ''/api/v0/accounts/group_operations/block_accounts_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияблокировка_всех_счетов_группы|Групповая операция: блокировка всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/block_accounts_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияблокировка_выбранных_счетов|Групповая операция: блокировка выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/change_accounts_properties'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияизменение_свойств_счетов|Групповая операция: изменение свойств счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/change_tags_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияизменение_тегов_всех_счетов_группы|Групповая операция: изменение тегов всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/change_tags_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияизменение_тегов_выбранных_счетов|Групповая операция: изменение тегов выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/change_valid_to_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциясрок_действия_всех_счетов_группы|Групповая операция: срок действия всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/change_valid_to_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциясрок_действия_выбранных_счетов|Групповая операция: срок действия выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/delete_accounts_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияудаление_всех_счетов_группы|Групповая операция: удаление всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/delete_accounts_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияудаление_выбранных_счетов|Групповая операция: удаление выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/discount_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияскидкабонус_всех_счетов_группы|Групповая операция: скидка/бонус всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/discount_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияскидкабонус_выбранных_счетов|Групповая операция: скидка/бонус выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/limits_discount_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциялимиты_скидкибонуса_всех_счетов_группы|Групповая операция: лимиты скидки/бонуса всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/limits_discount_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциялимиты_скидкибонуса_выбранных_счетов|Групповая операция: лимиты скидки/бонуса выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/limits_pay_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциялимиты_оплат_всех_счетов_группы|Групповая операция: лимиты оплат всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/limits_pay_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциялимиты_оплат_выбранных_счетов|Групповая операция: лимиты оплат выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/messages_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциясообщения_для_экранапечати_всех_счетов_группы|Групповая операция: сообщения для экрана/печати всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/messages_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциясообщения_для_экранапечати_выбранных_счетов|Групповая операция: сообщения для экрана/печати выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/phone_identifier_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциятелефон_как_идентификатор_для_всех_счетов_группы|Групповая операция: телефон как идентификатор для всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/phone_identifier_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операциятелефон_как_идентификатор_для_выбранных_счетов|Групповая операция: телефон как идентификатор для выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/refill_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияпополнение_баланса_всех_счетов_группы|Групповая операция: пополнение баланса всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/refill_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияпополнение_баланса_выбранных_счетов|Групповая операция: пополнение баланса выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/withdrawal_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияизъятие_с_баланса_всех_счетов_группы|Групповая операция: изъятие с баланса всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/withdrawal_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияизъятие_с_баланса_выбранных_счетов|Групповая операция: изъятие с баланса выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/group_operations/zero_by_account_group'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияобнуление_баланса_всех_счетов_группы|Групповая операция: обнуление баланса всех счетов группы]] |
| ''POST'' | ''/api/v0/accounts/group_operations/zero_by_accounts'' | [[external:pro_bonus:10_probonus_api:02_accounts#групповая_операцияобнуление_баланса_выбранных_счетов|Групповая операция: обнуление баланса выбранных счетов]] |
| ''POST'' | ''/api/v0/accounts/identifiers/generate_wallet_identifier'' | [[external:pro_bonus:10_probonus_api:02_accounts#сгенерировать_wallet-идентификатор_для_счёта|Сгенерировать wallet-идентификатор для счёта]] |
| ''POST'' | ''/api/v0/accounts/insert'' | [[external:pro_bonus:10_probonus_api:02_accounts#добавление_нового_элемента_справочника_счета|Добавление нового элемента справочника "Счета"]] |
| ''POST'' | ''/api/v0/accounts/insert_by_template'' | [[external:pro_bonus:10_probonus_api:02_accounts#добавление_нового_элемента_справочника_счета_с_автоматическим_заполнением_свойств_счёта_по_шаблону_группы_счетов|Добавление нового элемента справочника "Счета" с автоматическим заполнением свойств счёта по шаблону группы счетов]] |
| ''GET'' | ''/api/v0/accounts/list'' | [[external:pro_bonus:10_probonus_api:02_accounts#чтение_списка_элементов_справочника_счета_все_счета_или_счета_из_указанной_группы|Чтение списка элементов справочника "Счета" (все счета или счета из указанной группы)]] |
| ''GET'' | ''/api/v0/accounts/promo_stamps'' | [[external:pro_bonus:10_probonus_api:02_accounts#штампики_счёта_и_их_транзакции|Штампики счёта и их транзакции]] |
| ''POST'' | ''/api/v0/accounts/refill'' | [[external:pro_bonus:10_probonus_api:02_accounts#пополнение_баланса_счета_с_заданным_id|Пополнение баланса счета с заданным id]] |
| ''GET'' | ''/api/v0/accounts/tags/active'' | [[external:pro_bonus:10_probonus_api:02_accounts#получить_список_активных_тегов_счёта|Получить список активных тегов счёта]] |
| ''POST'' | ''/api/v0/accounts/tags/detach'' | [[external:pro_bonus:10_probonus_api:02_accounts#снять_тег_и_со_счетов|Снять тег(и) со счетов]] |
| ''POST'' | ''/api/v0/accounts/tags/set'' | [[external:pro_bonus:10_probonus_api:02_accounts#назначить_тег_и_счетам|Назначить тег(и) счетам]] |
| ''GET'' | ''/api/v0/accounts/transactions'' | [[external:pro_bonus:10_probonus_api:02_accounts#отчёт_по_транзакциям_по_счету_с_заданным_id|Отчёт по транзакциям по счету с заданным ID]] |
| ''POST'' | ''/api/v0/accounts/unblock'' | [[external:pro_bonus:10_probonus_api:02_accounts#разблокировка_элемента_справочника_счета_по_заданному_id|Разблокировка элемента справочника "Счета" по заданному id]] |
| ''POST'' | ''/api/v0/accounts/update'' | [[external:pro_bonus:10_probonus_api:02_accounts#обновление_элемента_справочника_счета_по_заданному_id|Обновление элемента справочника "Счета" по заданному id]] |
| ''POST'' | ''/api/v0/accounts/withdrawal'' | [[external:pro_bonus:10_probonus_api:02_accounts#изъятие_средств_с_баланса_счета_с_заданным_id|Изъятие средств с баланса счета с заданным id]] |
| ''POST'' | ''/api/v0/additional_contacts/add_additional_contact'' | [[external:pro_bonus:10_probonus_api:02_accounts#добавление_контакта_мессенджера_к_счёту|Добавление контакта мессенджера к счёту]] |
| ''GET'' | ''/api/v0/additional_contacts/find_account_by_additional_contact'' | [[external:pro_bonus:10_probonus_api:02_accounts#поиск_счёта_по_контакту_мессенджера|Поиск счёта по контакту мессенджера]] |
| ''GET'' | ''/api/v0/additional_contacts/get_by_type_and_value'' | [[external:pro_bonus:10_probonus_api:02_accounts#чтение_контакта_мессенджера_по_типу_и_значению|Чтение контакта мессенджера по типу и значению]] |
| ''POST'' | ''/api/v0/additional_contacts/insert_account_by_template_with_additional_contacts'' | [[external:pro_bonus:10_probonus_api:02_accounts#создание_счёта_по_шаблону_группы_вместе_с_контактами_мессенджеров|Создание счёта по шаблону группы вместе с контактами мессенджеров]] |
==== Справочники ====
^ Метод ^ Адрес ^ Назначение ^
| ''POST'' | ''/api/v0/account_groups/delete'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#удаление_элемента_справочника_группы_счетов_по_заданному_id|Удаление элемента справочника "Группы счетов" по заданному id]] |
| ''GET'' | ''/api/v0/account_groups/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_группы_счетов_по_заданному_id|Чтение элемента справочника "Группы счетов" по заданному id]] |
| ''POST'' | ''/api/v0/account_groups/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_нового_элемента_справочника_группы_счетов|Добавление нового элемента справочника "Группы счетов"]] |
| ''GET'' | ''/api/v0/account_groups/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_группы_счетов|Чтение списка элементов справочника "Группы счетов"]] |
| ''POST'' | ''/api/v0/account_groups/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновление_элемента_справочника_группы_счетов_по_заданному_id|Обновление элемента справочника "Группы счетов" по заданному id]] |
| ''POST'' | ''/api/v0/discounts/delete'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#удаление_элемента_справочника_составные_скидкибонусы_по_заданному_id|Удаление элемента справочника "Составные скидки/бонусы" по заданному id]] |
| ''GET'' | ''/api/v0/discounts/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_составные_скидкибонусы_по_заданному_id|Чтение элемента справочника "Составные скидки/бонусы" по заданному id]] |
| ''POST'' | ''/api/v0/discounts/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_нового_элемента_справочника_составные_скидкибонусы|Добавление нового элемента справочника "Составные скидки/бонусы"]] |
| ''GET'' | ''/api/v0/discounts/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_составные_скидкибонусы|Чтение списка элементов справочника "Составные скидки/бонусы"]] |
| ''POST'' | ''/api/v0/discounts/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновление_параметров_элемента_справочника_составные_скидкибонусы_по_заданному_id|Обновление параметров элемента справочника "Составные скидки/бонусы" по заданному id]] |
| ''POST'' | ''/api/v0/identifier_types/delete'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#удаление_элемента_спрвавочника_типы_идентификаторов_по_заданному_id|Удаление элемента спрвавочника "Типы идентификаторов" по заданному id]] |
| ''GET'' | ''/api/v0/identifier_types/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_типы_идентификаторов_по_заданному_id|Чтение элемента справочника "Типы идентификаторов" по заданному id]] |
| ''POST'' | ''/api/v0/identifier_types/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_нового_элемента_справочника_типы_идентификаторов|Добавление нового элемента справочника "Типы идентификаторов"]] |
| ''GET'' | ''/api/v0/identifier_types/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_типы_идентификаторов|Чтение списка элементов справочника "Типы Идентификаторов"]] |
| ''POST'' | ''/api/v0/identifier_types/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновлене_элемента_справочника_типы_идентификаторов_по_заданному_id|Обновлене элемента справочника "Типы идентификаторов" по заданному id]] |
| ''POST'' | ''/api/v0/restaurants/delete'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#удаление_элемента_справочника_рестораны_по_заданному_id|Удаление элемента справочника "Рестораны" по заданному id]] |
| ''GET'' | ''/api/v0/restaurants/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_рестораны_по_заданному_id|Чтение элемента справочника "Рестораны" по заданному id]] |
| ''POST'' | ''/api/v0/restaurants/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_нового_элемента_справочника_рестораны|Добавление нового элемента справочника "Рестораны"]] |
| ''GET'' | ''/api/v0/restaurants/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_рестораны|Чтение списка элементов справочника "Рестораны"]] |
| ''GET'' | ''/api/v0/restaurants/list_last_visited_by_account_id'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#рестораны_которые_недавно_посещал_гость|Рестораны, которые недавно посещал гость]] |
| ''POST'' | ''/api/v0/restaurants/restore'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#востановление_элемента_справочника_рестораны_по_заданному_id|Востановление элемента справочника "Рестораны" по заданному id]] |
| ''POST'' | ''/api/v0/restaurants/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновление_элемента_справочника_рестораны_по_заданному_id|Обновление элемента справочника "Рестораны" по заданному id]] |
| ''POST'' | ''/api/v0/tags/delete'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#удаление_элемента_справочника_теги_гостей_по_заданному_id|Удаление элемента справочника "Теги гостей" по заданному id]] |
| ''GET'' | ''/api/v0/tags/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_теги_гостей_по_заданному_id|Чтение элемента справочника "Теги гостей" по заданному id]] |
| ''POST'' | ''/api/v0/tags/groups/delete'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#удаление_элемента_справочника_группы_тегов_по_заданному_id|Удаление элемента справочника "Группы тегов" по заданному id]] |
| ''GET'' | ''/api/v0/tags/groups/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_группы_тегов_по_заданному_id|Чтение элемента справочника "Группы тегов" по заданному id]] |
| ''POST'' | ''/api/v0/tags/groups/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_элемента_справочника_группы_тегов|Добавление элемента справочника "Группы тегов"]] |
| ''GET'' | ''/api/v0/tags/groups/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_группы_тегов|Чтение списка элементов справочника "Группы тегов"]] |
| ''POST'' | ''/api/v0/tags/groups/restore'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#восстановление_удаленного_элемента_справочника_группы_тегов_по_заданному_id|Восстановление удаленного элемента справочника "Группы тегов" по заданному id]] |
| ''POST'' | ''/api/v0/tags/groups/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновление_элемента_справочника_группы_тегов|Обновление элемента справочника "Группы тегов"]] |
| ''POST'' | ''/api/v0/tags/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_элемента_справочника_теги_гостей|Добавление элемента справочника "Теги гостей"]] |
| ''GET'' | ''/api/v0/tags/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_теги_гостей|Чтение списка элементов справочника "Теги гостей"]] |
| ''POST'' | ''/api/v0/tags/restore'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#восстановление_удаленного_элемента_справочника_теги_гостей_по_заданному_id|Восстановление удаленного элемента справочника "Теги гостей" по заданному id]] |
| ''POST'' | ''/api/v0/tags/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновление_элемента_справочника_теги_гостей|Обновление элемента справочника "Теги гостей"]] |
| ''GET'' | ''/api/v0/coupons_dish/get'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_элемента_справочника_товарные_купоны_по_указанному_id|Чтение элемента справочника "Товарные купоны" по указанному id]] |
| ''POST'' | ''/api/v0/coupons_dish/insert'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#добавление_элемента_справочника_товарные_купоны_по_указанному_id|Добавление элемента справочника "Товарные купоны" по указанному id]] |
| ''GET'' | ''/api/v0/coupons_dish/list'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#чтение_списка_элементов_справочника_товарные_купоны|Чтение списка элементов справочника "Товарные купоны"]] |
| ''POST'' | ''/api/v0/coupons_dish/update'' | [[external:pro_bonus:10_probonus_api:03_dictionaries#обновление_элемента_справочника_товарные_купоны_по_указанному_id|Обновление элемента справочника "Товарные купоны" по указанному id]] |
==== Акции и сегменты ====
^ Метод ^ Адрес ^ Назначение ^
| ''GET'' | ''/api/v1/promotions/action_for_copy'' | [[external:pro_bonus:10_probonus_api:04_promotions#получение_действия_акции_для_копирования|Получение действия акции для копирования]] |
| ''POST'' | ''/api/v1/promotions/activate'' | [[external:pro_bonus:10_probonus_api:04_promotions#активация_сегментной_акции|Активация сегментной акции]] |
| ''POST'' | ''/api/v1/promotions/deactivate'' | [[external:pro_bonus:10_probonus_api:04_promotions#деактивация_сегментной_акции|Деактивация сегментной акции]] |
| ''POST'' | ''/api/v1/promotions/delete'' | [[external:pro_bonus:10_probonus_api:04_promotions#удаление_сегментной_акции|Удаление сегментной акции]] |
| ''GET'' | ''/api/v1/promotions/for_copy'' | [[external:pro_bonus:10_probonus_api:04_promotions#получение_сегментной_акции_для_копирования|Получение сегментной акции для копирования]] |
| ''GET'' | ''/api/v1/promotions/get'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_сегментной_акции_по_id|Чтение сегментной акции по id]] |
| ''POST'' | ''/api/v1/promotions/insert'' | [[external:pro_bonus:10_probonus_api:04_promotions#добавление_сегментной_акции|Добавление сегментной акции]] |
| ''GET'' | ''/api/v1/promotions/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#список_сегментных_акций|Список сегментных акций]] |
| ''POST'' | ''/api/v1/promotions/update'' | [[external:pro_bonus:10_probonus_api:04_promotions#изменение_сегментной_акции|Изменение сегментной акции]] |
| ''POST'' | ''/api/v0/promotions/activate'' | [[external:pro_bonus:10_probonus_api:04_promotions#активация_действия_акции_v0_устаревший|Активация действия акции (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/deactivate'' | [[external:pro_bonus:10_probonus_api:04_promotions#деактивация_действия_акции_v0_устаревший|Деактивация действия акции (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/delete'' | [[external:pro_bonus:10_probonus_api:04_promotions#удаление_действия_акции_v0_устаревший|Удаление действия акции (v0, устаревший)]] |
| ''GET'' | ''/api/v0/promotions/get'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_действия_акции_по_id_v0_устаревший|Чтение действия акции по id (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/insert'' | [[external:pro_bonus:10_probonus_api:04_promotions#добавление_действия_акции_v0_устаревший|Добавление действия акции (v0, устаревший)]] |
| ''GET'' | ''/api/v0/promotions/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#список_действий_акций_v0_устаревший|Список действий акций (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/update'' | [[external:pro_bonus:10_probonus_api:04_promotions#изменение_действия_акции_v0_устаревший|Изменение действия акции (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions_trigger/activate'' | [[external:pro_bonus:10_probonus_api:04_promotions#активация_триггерной_акции|Активация триггерной акции]] |
| ''POST'' | ''/api/v0/promotions_trigger/deactivate'' | [[external:pro_bonus:10_probonus_api:04_promotions#деактивация_триггерной_акции|Деактивация триггерной акции]] |
| ''POST'' | ''/api/v0/promotions_trigger/delete'' | [[external:pro_bonus:10_probonus_api:04_promotions#удаление_триггерной_акции|Удаление триггерной акции]] |
| ''GET'' | ''/api/v0/promotions_trigger/get'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_триггерной_акции_по_id|Чтение триггерной акции по id]] |
| ''POST'' | ''/api/v0/promotions_trigger/insert'' | [[external:pro_bonus:10_probonus_api:04_promotions#добавление_триггерной_акции|Добавление триггерной акции]] |
| ''GET'' | ''/api/v0/promotions_trigger/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#список_триггерных_акций|Список триггерных акций]] |
| ''POST'' | ''/api/v0/promotions_trigger/update'' | [[external:pro_bonus:10_probonus_api:04_promotions#изменение_триггерной_акции|Изменение триггерной акции]] |
| ''POST'' | ''/api/v0/promo_stamps/delete'' | [[external:pro_bonus:10_probonus_api:04_promotions#удаление_элемента_справочника_штамипики_n_1_по_указанному_id|Удаление элемента справочника "Штамипики (N+1)" по указанному id]] |
| ''GET'' | ''/api/v0/promo_stamps/get'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_элемента_справочника_штамипики_n_1_по_указанному_id|Чтение элемента справочника "Штамипики (N+1)" по указанному id]] |
| ''POST'' | ''/api/v0/promo_stamps/insert'' | [[external:pro_bonus:10_probonus_api:04_promotions#добавление_элемента_справочника_штамипики_n_1|Добавление элемента справочника "Штамипики (N+1)"]] |
| ''GET'' | ''/api/v0/promo_stamps/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_списка_элементов_справочника_штамипики_n_1|Чтение списка элементов справочника "Штамипики (N+1)"]] |
| ''POST'' | ''/api/v0/promo_stamps/update'' | [[external:pro_bonus:10_probonus_api:04_promotions#обновление_элемента_справочника_штамипики_n_1_по_указанному_id|Обновление элемента справочника "Штамипики (N+1)" по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/activate'' | [[external:pro_bonus:10_probonus_api:04_promotions#активация_промокода_по_указанному_id|Активация промокода по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/activate_code'' | [[external:pro_bonus:10_probonus_api:04_promotions#активация_промокода_по_коду_активации|Активация промокода по коду активации]] |
| ''POST'' | ''/api/v0/promocodes/deactivate'' | [[external:pro_bonus:10_probonus_api:04_promotions#деактивация_промокода_по_указанному_id|Деактивация промокода по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/delete'' | [[external:pro_bonus:10_probonus_api:04_promotions#удаление_элемента_справочника_промокоды_по_указанному_id|Удаление элемента справочника "Промокоды" по указанному id]] |
| ''GET'' | ''/api/v0/promocodes/get'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_элемента_справочника_промокоды_по_указанному_id|Чтение элемента справочника "Промокоды" по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/insert'' | [[external:pro_bonus:10_probonus_api:04_promotions#добавление_элемента_справочника_промокоды|Добавление элемента справочника "Промокоды"]] |
| ''GET'' | ''/api/v0/promocodes/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_списка_элементов_справочника_промокоды|Чтение списка элементов справочника "Промокоды"]] |
| ''GET'' | ''/api/v0/promocodes/promocodes_available'' | [[external:pro_bonus:10_probonus_api:04_promotions#получение_списка_доступных_промокодов_для_счета|Получение списка доступных промокодов для счета]] |
| ''POST'' | ''/api/v0/promocodes/update'' | [[external:pro_bonus:10_probonus_api:04_promotions#обновление_элемента_справочника_промокоды_по_указанному_id|Обновление элемента справочника "Промокоды" по указанному id]] |
| ''POST'' | ''/api/v0/segments/delete'' | [[external:pro_bonus:10_probonus_api:04_promotions#удаление_сегмента|Удаление сегмента]] |
| ''GET'' | ''/api/v0/segments/for_copy'' | [[external:pro_bonus:10_probonus_api:04_promotions#получение_сегмента_для_копирования|Получение сегмента для копирования]] |
| ''GET'' | ''/api/v0/segments/get'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_сегмента_по_id|Чтение сегмента по id]] |
| ''GET'' | ''/api/v0/segments/get_with_accounts_list'' | [[external:pro_bonus:10_probonus_api:04_promotions#чтение_сегмента_вместе_со_списком_счетов|Чтение сегмента вместе со списком счетов]] |
| ''POST'' | ''/api/v0/segments/insert'' | [[external:pro_bonus:10_probonus_api:04_promotions#добавление_сегмента|Добавление сегмента]] |
| ''GET'' | ''/api/v0/segments/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#список_сегментов|Список сегментов]] |
| ''GET'' | ''/api/v0/segments/list_by_account_id'' | [[external:pro_bonus:10_probonus_api:04_promotions#сегменты_в_которые_входит_счёт|Сегменты, в которые входит счёт]] |
| ''GET'' | ''/api/v0/segments/purchases/dishes_cache/list'' | [[external:pro_bonus:10_probonus_api:04_promotions#список_блюд_из_чеков_для_сегментов_по_покупкам|Список блюд из чеков (для сегментов по покупкам)]] |
| ''POST'' | ''/api/v0/segments/refresh_accounts_list'' | [[external:pro_bonus:10_probonus_api:04_promotions#пересчёт_состава_сегмента|Пересчёт состава сегмента]] |
| ''POST'' | ''/api/v0/segments/update'' | [[external:pro_bonus:10_probonus_api:04_promotions#изменение_сегмента|Изменение сегмента]] |
==== Рассылки, отзывы и Wallet ====
^ Метод ^ Адрес ^ Назначение ^
| ''POST'' | ''/api/v0/mailing/add_separate_message'' | [[external:pro_bonus:10_probonus_api:05_communications#отправка_отдельного_сообщения_гостю|Отправка отдельного сообщения гостю]] |
| ''POST'' | ''/api/v0/mailing/cancel'' | [[external:pro_bonus:10_probonus_api:05_communications#отмена_рассылки|Отмена рассылки]] |
| ''GET'' | ''/api/v0/mailing/config'' | [[external:pro_bonus:10_probonus_api:05_communications#доступные_каналы_рассылки|Доступные каналы рассылки]] |
| ''POST'' | ''/api/v0/media/upload_files'' | [[external:pro_bonus:10_probonus_api:05_communications#загрузка_файлов_изображений|Загрузка файлов (изображений)]] |
| ''POST'' | ''/api/v0/reviews/add_answer'' | [[external:pro_bonus:10_probonus_api:05_communications#ответ_на_отзыв|Ответ на отзыв]] |
| ''POST'' | ''/api/v0/reviews/add_message'' | [[external:pro_bonus:10_probonus_api:05_communications#добавление_сообщения_гостя_в_отзыв|Добавление сообщения гостя в отзыв]] |
| ''POST'' | ''/api/v0/reviews/close'' | [[external:pro_bonus:10_probonus_api:05_communications#закрытие_отзыва|Закрытие отзыва]] |
| ''GET'' | ''/api/v0/reviews/get_all_in_process_by_account_id'' | [[external:pro_bonus:10_probonus_api:05_communications#незавершённые_отзывы_гостя|Незавершённые отзывы гостя]] |
| ''GET'' | ''/api/v0/reviews/get_all_in_process_opened_minutes_ago'' | [[external:pro_bonus:10_probonus_api:05_communications#незавершённые_отзывы_открытые_n_минут_назад|Незавершённые отзывы, открытые N минут назад]] |
| ''GET'' | ''/api/v0/reviews/get_by_id_extended'' | [[external:pro_bonus:10_probonus_api:05_communications#чтение_отзыва_по_id_расширенно|Чтение отзыва по id (расширенно)]] |
| ''POST'' | ''/api/v0/reviews/insert'' | [[external:pro_bonus:10_probonus_api:05_communications#создание_отзыва|Создание отзыва]] |
| ''GET'' | ''/api/v0/reviews/list'' | [[external:pro_bonus:10_probonus_api:05_communications#список_отзывов|Список отзывов]] |
| ''POST'' | ''/api/v0/reviews/mark_processed'' | [[external:pro_bonus:10_probonus_api:05_communications#отметка_отзыва_как_обработанного|Отметка отзыва как обработанного]] |
| ''GET'' | ''/api/v0/wallet/get_balance'' | [[external:pro_bonus:10_probonus_api:05_communications#баланс_для_карты_wallet|Баланс для карты Wallet]] |
| ''GET'' | ''/api/v0/wallet/get_transactions'' | [[external:pro_bonus:10_probonus_api:05_communications#транзакции_для_карты_wallet|Транзакции для карты Wallet]] |
| ''POST'' | ''/api/v0/wallet/request_invoice'' | [[external:pro_bonus:10_probonus_api:05_communications#запрос_счёта_на_оплату_wallet|Запрос счёта на оплату Wallet]] |
==== Отчёты ====
^ Метод ^ Адрес ^ Назначение ^
| ''GET'' | ''/api/v0/reports/accounts_count_by_dates'' | [[external:pro_bonus:10_probonus_api:06_reports#прирост_гостевой_базы|Прирост гостевой базы]] |
| ''GET'' | ''/api/v0/reports/anti_fraud_events'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_по_антифроду|Отчет по "Антифроду"]] |
| ''GET'' | ''/api/v0/reports/birthdays'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_дни_рождения|Отчет "Дни рождения"]] |
| ''GET'' | ''/api/v0/reports/coupons_turnover'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_оборот_товарных_купонов|Отчет "Оборот товарных купонов"]] |
| ''GET'' | ''/api/v0/reports/dashboard/dashboard_accounts_counts_by_account_group'' | [[external:pro_bonus:10_probonus_api:06_reports#дашборд_количество_счетов_по_группам_счетов|Дашборд количество счетов по группам счетов]] |
| ''GET'' | ''/api/v0/reports/dashboard/dashboard_accounts_counts_by_ages'' | [[external:pro_bonus:10_probonus_api:06_reports#дашборд_количество_счетов_по_возрасту|Дашборд количество счетов по возрасту]] |
| ''GET'' | ''/api/v0/reports/dashboard/dashboard_accounts_counts_by_sex'' | [[external:pro_bonus:10_probonus_api:06_reports#дашборд_количество_счетов_по_полу|Дашборд количество счетов по полу]] |
| ''GET'' | ''/api/v0/reports/dashboard/sums_by_account_groups'' | [[external:pro_bonus:10_probonus_api:06_reports#дашборд_суммы_по_группам_счетов|Дашборд суммы по группам счетов]] |
| ''GET'' | ''/api/v0/reports/dashboard/sums_by_days'' | [[external:pro_bonus:10_probonus_api:06_reports#дашборд_суммы_по_дням|Дашборд суммы по дням]] |
| ''GET'' | ''/api/v0/reports/dashboard/sums_by_restaurants'' | [[external:pro_bonus:10_probonus_api:06_reports#дашборд_суммы_по_ресторанам|Дашборд суммы по ресторанам]] |
| ''GET'' | ''/api/v0/reports/download_accounts'' | [[external:pro_bonus:10_probonus_api:06_reports#выгрузка_всех_элементов_справочника_счета_в_xls_файл|Выгрузка всех элементов справочника "Счета" в xls файл]] |
| ''GET'' | ''/api/v0/reports/first_transaction_date_time'' | [[external:pro_bonus:10_probonus_api:06_reports#дата_и_время_первой_транзакции_в_базе|Дата и время первой транзакции в базе]] |
| ''GET'' | ''/api/v0/reports/identifiers'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_по_типам_идентификаторов|Отчет по типам идентификаторов]] |
| ''GET'' | ''/api/v0/reports/inactive_accounts'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_бездействующие_счета|Отчет "Бездействующие счета"]] |
| ''GET'' | ''/api/v0/reports/lost_accounts'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_потерянные_гости|Отчет "Потерянные гости"]] |
| ''GET'' | ''/api/v0/reports/loyalty_participants'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_по_участникам_программы_лояльности|Отчет по участникам программы лояльности]] |
| ''GET'' | ''/api/v0/reports/mailings_history'' | [[external:pro_bonus:10_probonus_api:06_reports#история_рассылок|История рассылок]] |
| ''GET'' | ''/api/v0/reports/meals_with_subsidies'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_питание_с_дотациями|Отчет "Питание с дотациями"]] |
| ''GET'' | ''/api/v0/reports/messages_by_mailing_id'' | [[external:pro_bonus:10_probonus_api:06_reports#сообщения_рассылки|Сообщения рассылки]] |
| ''GET'' | ''/api/v0/reports/promocodes'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_промокоды|Отчет "Промокоды"]] |
| ''GET'' | ''/api/v0/reports/promotion_actuation_history'' | [[external:pro_bonus:10_probonus_api:06_reports#история_запусков_акций|История запусков акций]] |
| ''GET'' | ''/api/v0/reports/promotion_actuation_logs'' | [[external:pro_bonus:10_probonus_api:06_reports#журнал_применения_акций|Журнал применения акций]] |
| ''GET'' | ''/api/v0/reports/promotion_actuation_logs_by_actuation_id'' | [[external:pro_bonus:10_probonus_api:06_reports#журнал_применения_акции_по_запуску|Журнал применения акции по запуску]] |
| ''GET'' | ''/api/v0/reports/promotions_effectiveness'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_эффективность_акций|Отчет "Эффективность акций"]] |
| ''GET'' | ''/api/v0/reports/referrals'' | [[external:pro_bonus:10_probonus_api:06_reports#отчёт_реферальная_программа|Отчёт «Реферальная программа»]] |
| ''GET'' | ''/api/v0/reports/referrals_graph'' | [[external:pro_bonus:10_probonus_api:06_reports#график_по_реферальной_программе|График по реферальной программе]] |
| ''GET'' | ''/api/v0/reports/rfm'' | [[external:pro_bonus:10_probonus_api:06_reports#отчёт_rfm-анализ|Отчёт «RFM-анализ»]] |
| ''GET'' | ''/api/v0/reports/spent_by_days'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_потраты_по_дням|Отчет "Потраты по дням"]] |
| ''GET'' | ''/api/v0/reports/stamps'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_по_штампикам|Отчет по штампикам]] |
| ''GET'' | ''/api/v0/reports/stamps_graph'' | [[external:pro_bonus:10_probonus_api:06_reports#график_штампиков|График штампиков]] |
| ''GET'' | ''/api/v0/reports/sums'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_суммовой|Отчет "Суммовой"]] |
| ''GET'' | ''/api/v0/reports/top_guests'' | [[external:pro_bonus:10_probonus_api:06_reports#топ_гостей|Топ гостей]] |
| ''GET'' | ''/api/v0/reports/transactions'' | [[external:pro_bonus:10_probonus_api:06_reports#отчет_транзакции|Отчет "Транзакции"]] |
| ''GET'' | ''/api/v0/checks/get_by_id'' | [[external:pro_bonus:10_probonus_api:06_reports#получение_гостевого_содержимого_чека_r_keeper_по_id|Получение гостевого содержимого чека r_keeper по id]] |
==== Внешние продажи, импорт и инфокиоск ====
^ Метод ^ Адрес ^ Назначение ^
| ''POST'' | ''/api/v0/external/register_check'' | [[external:pro_bonus:10_probonus_api:07_integration#регистрация_внешней_продажи|Регистрация внешней продажи]] |
| ''POST'' | ''/api/v0/external/return_check'' | [[external:pro_bonus:10_probonus_api:07_integration#отмена_внешней_продажи|Отмена внешней продажи]] |
| ''POST'' | ''/api/v0/import_data/import_parsed_rk_pds_row'' | [[external:pro_bonus:10_probonus_api:07_integration#импорт_в_группу_счетов|Импорт в группу счетов]] |
| ''POST'' | ''/api/v0/import_data/import_parsed_spending'' | [[external:pro_bonus:10_probonus_api:07_integration#импорт_распарсенных_потрат_в_бд|Импорт распарсенных потрат в БД]] |
| ''POST'' | ''/api/v0/import_data/import_previous_telegram_bot_db'' | [[external:pro_bonus:10_probonus_api:07_integration#импорт_базы_предыдущей_версии_telegram-бота|Импорт базы предыдущей версии Telegram-бота]] |
| ''GET'' | ''/api/v0/import_data/import_task_status'' | [[external:pro_bonus:10_probonus_api:07_integration#проверка_статуса_задачи_импорта_по_task_id|Проверка статуса задачи импорта по task_id]] |
| ''POST'' | ''/api/v0/import_data/parse_rk_pds_csv'' | [[external:pro_bonus:10_probonus_api:07_integration#загрузка_импорт_счетов_из_файла_обмена_csv|Загрузка (импорт) счетов из файла обмена (CSV)]] |
| ''POST'' | ''/api/v0/import_data/parse_spending_csv'' | [[external:pro_bonus:10_probonus_api:07_integration#парсинг_csv_файла_с_потратами_идентификатор_сумма|Парсинг CSV файла с потратами (идентификатор, сумма)]] |
| ''GET'' | ''/screen/client/get/'' | [[external:pro_bonus:10_probonus_api:07_integration#страница_инфокиоска_ввод_карты|Страница инфокиоска (ввод карты)]] |
| ''POST'' | ''/screen/client/get/'' | [[external:pro_bonus:10_probonus_api:07_integration#поиск_гостя_на_инфокиоске|Поиск гостя на инфокиоске]] |
==== Настройки сервера ====
^ Метод ^ Адрес ^ Назначение ^
| ''GET'' | ''/api/v0/config/ai/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_ии_для_отзывов|Чтение настроек ИИ для отзывов]] |
| ''POST'' | ''/api/v0/config/ai/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_ии_для_отзывов|Изменение настроек ИИ для отзывов]] |
| ''GET'' | ''/api/v0/config/anti_fraud/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_антифрода|Чтение настроек Антифрода]] |
| ''POST'' | ''/api/v0/config/anti_fraud/notifications_tg_bot/register'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_списка_получателей_зарегистрировавшихся_для_получения_уведомлений_по_событиям_антифрод|Чтение списка получателей зарегистрировавшихся для получения уведомлений по событиям Антифрод]] |
| ''POST'' | ''/api/v0/config/anti_fraud/notifications_tg_bot/update_receiver'' | [[external:pro_bonus:10_probonus_api:08_config#блокировкаразблокировка_получателей_уведомлений_по_событиям_антифрода|Блокировка/разблокировка получателей уведомлений по событиям "Антифрода"]] |
| ''POST'' | ''/api/v0/config/anti_fraud/update'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_настроек_антифрода|Обновление настроек Антифрода]] |
| ''GET'' | ''/api/v0/config/api_version'' | [[external:pro_bonus:10_probonus_api:08_config#версия_api|Версия API]] |
| ''GET'' | ''/api/v0/config/app_version'' | [[external:pro_bonus:10_probonus_api:08_config#запрос_версии_приложения_probonus|Запрос версии приложения ProBonus]] |
| ''GET'' | ''/api/v0/config/application/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_по_probonus|Чтение настроек ПО ProBonus]] |
| ''POST'' | ''/api/v0/config/application/update'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_настроек_по_probonus|Обновление настроек ПО ProBonus]] |
| ''POST'' | ''/api/v0/config/cash_settings/delete'' | [[external:pro_bonus:10_probonus_api:08_config#удаление_профиля_регистрации_с_кассы|Удаление профиля регистрации с кассы]] |
| ''GET'' | ''/api/v0/config/cash_settings/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_профиля_регистрации_с_кассы_по_id|Чтение профиля регистрации с кассы по id]] |
| ''GET'' | ''/api/v0/config/cash_settings/get_by_token'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_профиля_регистрации_с_кассы_по_токену|Чтение профиля регистрации с кассы по токену]] |
| ''POST'' | ''/api/v0/config/cash_settings/insert'' | [[external:pro_bonus:10_probonus_api:08_config#добавление_профиля_регистрации_с_кассы|Добавление профиля регистрации с кассы]] |
| ''GET'' | ''/api/v0/config/cash_settings/list'' | [[external:pro_bonus:10_probonus_api:08_config#список_профилей_регистрации_с_кассы|Список профилей регистрации с кассы]] |
| ''POST'' | ''/api/v0/config/cash_settings/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_профиля_регистрации_с_кассы|Изменение профиля регистрации с кассы]] |
| ''GET'' | ''/api/v0/config/db/available_databases'' | [[external:pro_bonus:10_probonus_api:08_config#ввод_строки_соединения_с_бд|Ввод строки соединения с БД]] |
| ''GET'' | ''/api/v0/config/db/available_drivers'' | [[external:pro_bonus:10_probonus_api:08_config#запрос_доступного_драйвера_для_бд_клиента|Запрос доступного драйвера для БД клиента]] |
| ''GET'' | ''/api/v0/config/db/check_connection_string'' | [[external:pro_bonus:10_probonus_api:08_config#проверка_настроек_соединения_с_бд|Проверка настроек соединения с БД]] |
| ''GET'' | ''/api/v0/config/db/connection_string'' | [[external:pro_bonus:10_probonus_api:08_config#запрос_строки_соединения_с_бд|Запрос строки соединения с БД]] |
| ''POST'' | ''/api/v0/config/db/create'' | [[external:pro_bonus:10_probonus_api:08_config#создание_структуры_бд|Создание структуры БД]] |
| ''GET'' | ''/api/v0/config/db/info'' | [[external:pro_bonus:10_probonus_api:08_config#запрос_информации_о_бд|Запрос информации о БД]] |
| ''POST'' | ''/api/v0/config/db/update'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_версии_бд_при_обновлении_версии_по|Обновление версии БД (при обновлении версии ПО)]] |
| ''POST'' | ''/api/v0/config/db/update_connection_string'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_строки_соединения_с_бд|Обновление строки соединения с БД]] |
| ''GET'' | ''/api/v0/config/info_kiosk/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_инфокиоска|Чтение настроек инфокиоска]] |
| ''POST'' | ''/api/v0/config/info_kiosk/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_инфокиоска|Изменение настроек инфокиоска]] |
| ''GET'' | ''/api/v0/config/mailing/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_рассылок|Чтение настроек рассылок]] |
| ''POST'' | ''/api/v0/config/mailing/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_рассылок|Изменение настроек рассылок]] |
| ''GET'' | ''/api/v0/config/max_bot/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_max-бота|Чтение настроек MAX-бота]] |
| ''GET'' | ''/api/v0/config/max_bot/get_bot_info'' | [[external:pro_bonus:10_probonus_api:08_config#информация_о_max-боте_по_токену|Информация о MAX-боте по токену]] |
| ''GET'' | ''/api/v0/config/max_bot/get_phrases_meta'' | [[external:pro_bonus:10_probonus_api:08_config#список_настраиваемых_фраз_max-бота|Список настраиваемых фраз MAX-бота]] |
| ''POST'' | ''/api/v0/config/max_bot/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_max-бота|Изменение настроек MAX-бота]] |
| ''GET'' | ''/api/v0/config/max_bot/validate_token'' | [[external:pro_bonus:10_probonus_api:08_config#проверка_токена_max-бота|Проверка токена MAX-бота]] |
| ''GET'' | ''/api/v0/config/policies/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_текстов_политик_и_согласий|Чтение текстов политик и согласий]] |
| ''POST'' | ''/api/v0/config/policies/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_текстов_политик_и_согласий|Изменение текстов политик и согласий]] |
| ''GET'' | ''/api/v0/config/r_keeper/bonus_types/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_справочника_тип_бонуса_из_r_keeper|Чтение справочника "Тип бонуса" из r_keeper]] |
| ''GET'' | ''/api/v0/config/r_keeper/connection/check'' | [[external:pro_bonus:10_probonus_api:08_config#проверка_связи_с_r_keeper|Проверка связи с r_keeper]] |
| ''GET'' | ''/api/v0/config/r_keeper/connection/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_связи_с_r_keeper|Чтение настроек связи с r_keeper]] |
| ''POST'' | ''/api/v0/config/r_keeper/connection/update'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_настроек_связи_с_r_keeper|Обновление настроек связи с r_keeper]] |
| ''GET'' | ''/api/v0/config/r_keeper/discounts/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_справочника_скидки_из_r_keeper|Чтение справочника "Скидки" из r_keeper]] |
| ''GET'' | ''/api/v0/config/r_keeper/extended/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_кода_нулевой_скидки|Чтение кода "Нулевой скидки"]] |
| ''POST'' | ''/api/v0/config/r_keeper/extended/update'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_кода_нулевой_скидки|Обновление кода "Нулевой скидки"]] |
| ''GET'' | ''/api/v0/config/r_keeper/menu_items/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_справочника_меню_из_r_keeper|Чтение справочника "Меню" из r_keeper]] |
| ''GET'' | ''/api/v0/config/referral_program/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_реферальной_программы|Чтение настроек реферальной программы]] |
| ''POST'' | ''/api/v0/config/referral_program/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_реферальной_программы|Изменение настроек реферальной программы]] |
| ''GET'' | ''/api/v0/config/server/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_сервера_probonus|Чтение настроек сервера ProBonus]] |
| ''POST'' | ''/api/v0/config/server/update'' | [[external:pro_bonus:10_probonus_api:08_config#обновление_настроек_сервера_probonus|Обновление настроек сервера ProBonus]] |
| ''GET'' | ''/api/v0/config/telegram_bot/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_telegram-бота|Чтение настроек Telegram-бота]] |
| ''GET'' | ''/api/v0/config/telegram_bot/get_bot_info'' | [[external:pro_bonus:10_probonus_api:08_config#информация_о_telegram-боте_по_токену|Информация о Telegram-боте по токену]] |
| ''GET'' | ''/api/v0/config/telegram_bot/get_phrases_meta'' | [[external:pro_bonus:10_probonus_api:08_config#список_настраиваемых_фраз_telegram-бота|Список настраиваемых фраз Telegram-бота]] |
| ''POST'' | ''/api/v0/config/telegram_bot/import_config'' | [[external:pro_bonus:10_probonus_api:08_config#импорт_настроек_telegram-бота_из_файла|Импорт настроек Telegram-бота из файла]] |
| ''POST'' | ''/api/v0/config/telegram_bot/import_description_and_politics'' | [[external:pro_bonus:10_probonus_api:08_config#импорт_описания_и_политик_telegram-бота_из_файла|Импорт описания и политик Telegram-бота из файла]] |
| ''POST'' | ''/api/v0/config/telegram_bot/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_telegram-бота|Изменение настроек Telegram-бота]] |
| ''GET'' | ''/api/v0/config/wallet/card_templates/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_шаблона_карты_wallet|Чтение шаблона карты Wallet]] |
| ''POST'' | ''/api/v0/config/wallet/card_templates/insert'' | [[external:pro_bonus:10_probonus_api:08_config#добавление_шаблона_карты_wallet|Добавление шаблона карты Wallet]] |
| ''GET'' | ''/api/v0/config/wallet/card_templates/list'' | [[external:pro_bonus:10_probonus_api:08_config#список_шаблонов_карт_wallet|Список шаблонов карт Wallet]] |
| ''POST'' | ''/api/v0/config/wallet/card_templates/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_шаблона_карты_wallet|Изменение шаблона карты Wallet]] |
| ''GET'' | ''/api/v0/config/wallet/locations/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_геолокаций_wallet|Чтение геолокаций Wallet]] |
| ''POST'' | ''/api/v0/config/wallet/locations/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_геолокаций_wallet|Изменение геолокаций Wallet]] |
| ''GET'' | ''/api/v0/config/wallet_guest_form/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_настроек_формы_гостя_wallet|Чтение настроек формы гостя Wallet]] |
| ''POST'' | ''/api/v0/config/wallet_guest_form/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_настроек_формы_гостя_wallet|Изменение настроек формы гостя Wallet]] |
| ''GET'' | ''/api/v0/config/wallet_main/get'' | [[external:pro_bonus:10_probonus_api:08_config#чтение_основных_настроек_wallet|Чтение основных настроек Wallet]] |
| ''POST'' | ''/api/v0/config/wallet_main/update'' | [[external:pro_bonus:10_probonus_api:08_config#изменение_основных_настроек_wallet|Изменение основных настроек Wallet]] |