Документация · версия 1.0
Бонуска24
Корпоративный магазин поощрений в Битрикс24. Сотрудники и отделы получают бонусы за достижения и обменивают их на товары и привилегии из каталога.
Функциональные характеристики
- Личный и командный каталоги. Поиск по названию и описанию, фильтрация по категориям, сортировка по названию и цене. Карточка показывает цену и доступность покупки по текущему балансу.
- Покупки и подарки. Сотрудник выбирает количество и оплачивает заказ бонусами со своего счёта или со счёта отдела. Товар можно купить в подарок коллеге или отделу. При оформлении заказа программа проверяет баланс.
- Балансы и история. Сотрудник видит личный и командный балансы, покупки, начисления и списания. Личные бонусы можно перевести коллеге с сообщением.
- Управление. Администратор ведёт каталог, начисляет и списывает бонусы, просматривает заказы, балансы и историю операций по сотрудникам и отделам.
Приложение открывается внутри Битрикс24 с учётной записью пользователя портала. Каталог, операции и заказы хранятся в универсальных списках, изображения товаров — на Диске портала. Интерфейс адаптируется к размеру экрана.
Руководство по установке и запуску
Требования
- Облачный Битрикс24 или коробочная редакция «1С-Битрикс24» с REST API, «Универсальными списками» и «Диском». Для регистрации приложения нужна учётная запись администратора портала.
- HTTPS-сервер с действующим сертификатом. Поддерживаемые варианты размещения: веб-сервер с PHP 7.4 и выше, nginx 1.20 и выше или Docker с HTTPS-прокси.
- Актуальный браузер: Яндекс Браузер, Google Chrome, Mozilla Firefox, Microsoft Edge или Safari.
Размещение сборки
Используйте готовую сборку dist. При сборке из исходников понадобятся Node.js 22 или новее и npm. Команды выполняются из каталога проекта.
npm ci
npm run build Варианты размещения
- PHP. Скопируйте содержимое
distв каталог сайта и предоставьте веб-серверу доступ к файлам. Адрес обработчика указывает наindex.phpв этом каталоге. Файл обрабатывает POST-запрос, которым портал открывает приложение. - nginx. Разместите содержимое
distв корневом каталоге сайта и подключитеnginx.confиз поставки. Адрес обработчика — HTTPS-адрес сайта приложения. - Docker. Соберите образ с
Dockerfileиз поставки. Контейнер принимает запросы на порту 80. Настройте перед ним обратный прокси с HTTPS.
Регистрация в Битрикс24
- Откройте «Приложения» → «Разработчикам» → «Другое» → «Локальное приложение».
- Укажите название «Бонуска24» и HTTPS-адрес обработчика в полях «Путь вашего обработчика» и «Путь для первоначальной установки». Предоставьте приложению права
user,department,listsиdisk. - Сохраните приложение и откройте его в меню «Приложения» от имени администратора. Программа создаст недостающие списки «Bonusly: Товары», «Bonusly: Баланс» и «Bonusly: Заказы». Укажите название внутренней валюты.
- Добавьте тестовый товар и начислите бонусы. Проверьте в учётной записи сотрудника, что каталог и баланс открываются и покупка появляется в разделе «Все заказы» у администратора.
Обновление и диагностика
Для обновления замените файлы на сервере новой сборкой dist. Сохраните тот же адрес обработчика. Данные хранятся в списках и на Диске портала.
- При пустом экране проверьте HTTPS и обработку POST.
- При ошибке загрузки данных проверьте права приложения и пользователя на списки.
- Для доступа к «Админ-панели» войдите с учётной записью администратора портала.
- Если изображения отсутствуют, проверьте права чтения папки приложения на общем Диске.
Руководство пользователя
Вход и каталог
В Битрикс24 откройте «Приложения» → «Бонуска24». При первом входе откроется обучающий тур. Его можно запустить позже из меню пользователя по пункту «Как это работает?». Переключатель «Личные» / «Командные» меняет каталог и счёт для оплаты.
Покупка
- Откройте карточку товара, нажмите «Купить» и укажите количество.
- Для подарка включите «Купить в подарок», выберите коллегу или отдел и добавьте сообщение. При командной покупке выберите отдел, если состоите в нескольких.
- Проверьте стоимость и удерживайте кнопку подтверждения до завершения. Заказ появится в истории покупок. Порядок и сроки выдачи товара определяет компания.
Перевод бонусов и история
Для перевода откройте «Мой кабинет» → «Подарить коллеге», выберите сотрудника, укажите сумму и подтвердите операцию. Личная и командная вкладки кабинета показывают покупки и движение бонусов. Баланс обновляется автоматически раз в минуту.
Руководство администратора
Каталог, бонусы и заказы
- В «Админ-панель» → «Управление товарами» нажмите «Добавить товар», укажите название, описание, стоимость, категорию и тип товара. Загрузите изображения. Первое станет обложкой карточки.
- Через «Выдать баллы» выберите сотрудника или отдел и укажите сумму и причину. Положительная сумма начисляет бонусы, отрицательная списывает их.
- Раздел «Все заказы» показывает дату покупки, товар, количество, покупателя, получателя подарка и стоимость. Выдача товара ведётся по регламенту компании. Возврат оформляется начислением суммы заказа с указанием причины.
- В «Статистике» доступны суммарные показатели, балансы сотрудников и отделов и журнал операций.
Права и резервное копирование
Сотрудникам нужны чтение списка товаров и папки «Бонуска24», а для списков баланса и заказов — чтение и добавление элементов. Права редактирования и удаления операций рекомендуется оставить администраторам. Для резервного копирования используйте средства портала. Универсальные списки дополнительно можно выгрузить в Excel.
Перенос и переустановка
При переходе с прежней версии кнопка «Перенести изображения» копирует файлы в папку приложения на общем Диске и обновляет ссылки в товарах. При переустановке сохраните названия трёх списков и их полей. Если параметры приложения были удалены, укажите название внутренней валюты повторно.
При диагностике используйте вкладку «Консоль» в браузере. К обращению в службу поддержки приложите снимок экрана и текст ошибки.
