Документация BGBilling
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Назначение модуля

Модуль Vidimax предназначен для интеграции биллинга с поставщиком услуг video on demand Vidimax. На данный момент модуль предоставляет следующие возможности:

  • автоматическая привязка ЛС Абонента в Vidimax к договору в биллинге.

  • установка тарифов Vidimax на договоре в момент создания ИД абонента.

  • возможность оплаты услуг Vidimax, после привязки, со счета клиента;

  • просмотр платежей и активных тарифов клиента из договора.

Настройка модуля

Установите модуль на сервер, обновите клиентскую часть. Затем создайте экземпляр модуля. Создайте в редакторе конфигурации модуля новую конфигурацию, скопируйте туда приведённый ниже текст и введите требуемые параметры. После этого сохраните конфигурацию и сделайте её активной.

Конфигурация 
#######################################     Обязательные параметры     ################################

# параметр используется при генерации подписи к запросу (выдается Vidimax-ом)
operator.secret=password

# логин и пароль Basic http аутентификации для запроса на списание средств ( вы передаёте Vidimax-у )
basic.auth.login=username
basic.auth.password=password

# логин и пароль Basic http аутентификации модуля на сервере Vidimax ( выдается Vidimax-ом )
vidimax.basic.auth.login=vmusername
vidimax.basic.auth.password=vmpassword

# url для получения тарифных планов( TV и VoD ) к нему после добавиться listActiveTariffsTv или listActiveTariffsVod
url.tariff.active=https://adressVidimax:1234/api/5.0/

# Код наработки услуги по дефолту, это с каким типом наработки будут начисляться наработка
account.default.serviceId=1

#######################################     Рекомендуемые параметры     ###############################
#активные статусы договора, при которых возможно списание средств
contract.status.active.codes=0

# Для отображения названия тарифов в расходах видимакса вместо их кодов, перечислите их как показано ниже.
tariffsIds=0,210,492
tariff.0.title=Тариф 90 руб
tariff.210.title=Тариф 300 руб
tariff.492.title=Тариф 500 руб

# Идентификаторы тарифов которые можно будет добавить абоненту до связывания( из списка tariffsIds ):
tariffsIds.available=492,0

# Описание сервисов видимакса для наглядного их отображения в расходах Видимакса.
serviceIds=1,2,3,4,5
service.1.title=Аренда SD фильма
service.2.title=Аренда HD фильма
service.3.title=Покупка SD
service.4.title=Покупка HD
service.5.title=Абон. плата за тариф

# Вместо account.default.serviceId можно использовать другой код наработки для отдельных типов сервиса Видимакса.
service.1.accountServiceId=41
service.2.accountServiceId=52
service.4.accountServiceId=21

#######################################     Дополнительные параметры     ##############################

# Отключение наработки по тарифам. Введите коды тарифов на которые не будут вешаться наработки( только для Абонентской платы ), то есть вы будете субсидировать клиентов по абонкам данных тарифов.
#tariffsIds.notAccounting=492

# Включение возможности удаления связанных договоров( рекомендуется только на время тестирования модуля )
#contract.canDeletePaired=1

Замечания:

  1. Прежде, чем задавать account.default.serviceId или service.X.accountServiceId(где X код сервиса видимакса) необходимо создать соответствующую услугу в Модули->Редактор модулей и услуг->"Название вашего модуля", а коды услуг вписать в значения параметров.

  2. После заключения договора с системой Vidimax нужно будет передать им значение URL-адреса, по которому к биллингу будут приходить запросы. URL должен выглядеть следующим образом: http://<адрес_машины_биллинга>/vidimax_api/<mid> .

    Например, если у вас биллинг находится по адресу http://billing.example.com/bgbilling/ и модуль Vidimax имеет mid=17, то результирующее URL, которые нужно передать компании Vidimax, выглядит следующим образом: http://billing.example.com/bgbilling/vidimax_api/17.

  3. Логин и пароль для запроса на списание средств запрашиваются при входящем запросе с сервера Vidimax на списание средств.

Принцип работы модуля

Последовательность действий при работе с модулем следующая:

  1. Заводится договор;

  2. Вносится номер телефона в модуль( он выступает в качестве идентификатора для Vidimax-а ) и если надо выбирается тариф;

  3. Пользователь подключает приставку и производиться автоматическое связывание ЛС Vidimax-а и Билинга на основании идентификатора;

  4. Далее Vidimax может запросить списание средств;

Алгоритм списания средсв:

  1. Поиск договора с переданным от Vidimax ид. абонента;

  2. Проверка является ли договор связанным;

  3. Проверка является ли статус договор разрешенным для данного модуля( параметр contract.status.active.codes );

  4. Проверка на достаточность средств на договоре( расход Vidimax-a будет отвергнут, если баланс станет ниже 0 в результате этого расхода );

  5. Добавляется наработка на договор( если только данный тариф не входит в параметр tariffsIds.notAccounting и расход является абонентской платой );

Мониторинг платежей

В клиенте билинга( а так-же в ЛК клиента ) есть возможность отслеживать историю расходов по каждому абоненту. Для этого необходимо выбрать модуль Vidimax в дереве параметров договора. Платежи можно отображать с фильтрацией по периоду, в течение которого производилось списание средств.

 

  • Нет меток