Веб-расширения

Раздел для разработчиков. Веб-расширения — сторонние программы (веб-модули), работающие внутри интерфейса Бипиума. Расширение состоит из JS-файла, CSS-файла и дополнительных ресурсов.

Раздел для разработчиков. Веб-расширения — сторонние программы (веб-модули), работающие внутри интерфейса Бипиума. Расширение состоит из JS-файла, CSS-файла и дополнительных ресурсов.

Подключение расширений доступно только в серверной версии Бипиума.

Типы расширений

Тип

Описание

Модальные

Открываются в отдельном слое поверх открытого раздела. Могут занимать часть экрана или всю рабочую область. Основной экран Бипиума остаётся в DOM-дереве.

Экранные

Занимают всю рабочую область, замещая открытый раздел в DOM-дереве. Поддерживаются частично.

Фоновые

Работают в фоне и управляют DOM-деревом — встраивают элементы в нужный момент.

Создание расширений

1. Выберите уникальный код

Каждое расширение имеет уникальный код-идентификатор. Код может состоять из латинских букв, цифр и дефиса.

2. Напишите расширение

Напишите необходимое расширение.

3. Зарегистрируйте расширение

Бипиум защищает расширения от тиражирования через систему лицензирования. Подключение расширения к системе возможно только при наличии лицензии.

Чтобы зарегистрировать расширение — напишите на support@bpium.ru, указав уникальный код расширения и регистрационный номер лицензии компании.

Без регистрации расширения в системе лицензирования подключить его будет невозможно.

Подключение расширений

  1. Разместите файлы расширения на внешнем веб-сервере или в рабочей папке сервера Бипиума:

bpium_path/www/modules/my-extension/

Если серверов несколько — скопируйте файлы на каждый.

  1. Откройте каталог «Расширения» в разделе «Система».

  2. Создайте новую запись со следующими полями:

Поле

Описание

Название

Название расширения в главном меню приложения

Иконка

Иконка в главном меню

Код

Уникальный идентификатор, должен совпадать с переменной moduleName в скрипте

JS URL

Путь до JS-скрипта. Например: modules/my-extension/main.js

CSS URL

Путь до CSS-файла. Например: modules/my-extension/main.css

  1. Сохраните запись и обновите страницу в браузере. Если всё верно — во вкладке Network браузера появятся запросы к вашим файлам.

Проверка подключения

При старте веб-приложение Бипиум делает запрос к серверу /auth/company. Ответ содержит массив подключённых расширений:

{
  "domain": "admin",
  "title": "Моя компания",
  "extensions": ["массив расширений"]
}

Сервер не вернёт расширения, на которые нет лицензии для данной компании.