BQN Documentation
BQN Documentation

Overview

In addition to RADIUS and REST, subscriber data can be retrieved from a number of supported billing systems.

Azotel

The BQN retrieves the customer bucket data and get from it the speed limits to apply (uploadrate and downloadrate).

To activate Azotel, go to Configuration->RADIUS/REST/Billing->Billing Systems, select Azotel and enable the switch.

A user and password will also be needed for REST API access. They must be created in the Azotel system with allowed access from BQN IP address. The BQN will use its management address for Azotel queries, but bear in mind that if the BQN reaches Azotel over the Internet, Azotel will see a public IP address and this is the one that will need  authorization by the Azotel system.

Provide also the Azotel system IP address or server name and port number (443 by default).

Azotel customers in a status other than “current” will be blocked (they are regarded as lacking a valid subscription). You can change this behaviour to non-blocking using the BQN CLI shell as follows:

 
bqnadm@bqn# configure
bqnadm@bqn(config)# api billing
bqnadm@bqn(config-ext)# no blocking
bqnadm@bqn(config-ext)# commit
bqnadm@bqn(config-ext)# end
bqnadm@bqn#

Powercode

To activate Powercode, go to Configuration->RADIUS/REST/Billing->Billing Systems, select Powercode and enable the switch.

Provide the Powercode system IP address or server name and its port number (22 by default).

The BQN server needs SSH access to the Powercode server using  a Unix User/Password. Italso needs read access to the MySQL database. If MySQL user/password is different to the Unix user/password, that should be specified in MySQL Credentials.

Powercode customers in a status other than “Active” will be blocked (they are regarded as lacking a valid subscription). You can change this behaviour to non-blocking using the BQN CLI shell as follows:

 
bqnadm@bqn# configure
bqnadm@bqn(config)# api billing
bqnadm@bqn(config-ext)# no blocking
bqnadm@bqn(config-ext)# commit
bqnadm@bqn(config-ext)# end
bqnadm@bqn#

REST-API Powercode

Powercode billing restricts REST API to three requests per second. For that reason, the preferred integration is usingthe SQL access described in the previous section. REST-API can be used when SQLcannot be used and the number of subscribers is low (one thousand or less).

The BQN retrieves CPE equipment of a certain category (1 by default). For subscribers with that category of equipment, it will retrieve the rate limits of their Internet service (“internetInfo”).

To activate Powercode, go to Configuration->External Subscriber Data->Billing Systems , select Powercode enable the switch.

An API Key will also be needed. The API key must be created in the Powercode system, with allowed access from BQN IP address (the BQN will use its management address for Powercodequeries).

Provide also the Powercode system IP address or server name and port number(444 by default).

If the CPE equipment category in the Powercode database is other than 1, change it. More than one category can be specified typing the category numbers separated by spaces (e.g. “10 11 12” for categories 10, 11 and 12).

Splynx

The BQN retrieves the customer tariff and get from it the speed limits to apply and the burst rates, thresholds and duration.

To activate Splynx, go to Configuration->RADIUS/REST/Billing->Billing Systems, select Splynx and enable the switch.

An API key and secret will be needed. They must be created in the Splynx system with the following settings:

  • Enable basic authorization for this key.
  • Leave empty Allowed list for IPs or include the BQN IP address. The BQN will use its management address for Splynx queries but bear in mind that if the BQN reaches Splynx over the Internet, Splynx will see a public IP address and this is the one that will need authorization by the Splynx system.
  • Add view permissions for database items Tariff plans ->Internet and Customers->Customers online.

The following screenshots show the API KEY and the access permits:

Provide also the Splynx system IP address or server name and port number (443 by default).

Splynx customers with “1” in their blocked field, will be blocked (they are regarded as lacking a valid subscription). You can change this behaviour to non-blocking using the BQN CLI shell as follows:

 
bqnadm@bqn# configure
bqnadm@bqn(config)# api billing
bqnadm@bqn(config-ext)# no blocking
bqnadm@bqn(config-ext)# commit
bqnadm@bqn(config-ext)# end
bqnadm@bqn#

previous
NEXT