Configure REST in the BQN

1.      To activate the REST API in the BQN, go to Configuration->RESTAPI and switch Rest API to On.

2.      Add the IP addresses of all REST clients to the BQN configuration. In the GUI, go to Configuration->REST API and click on Add Client…

3.      Add the REST users, along with their passwords, tothe BQN configuration. In the GUI, go to Configuration->REST API and click on Add User…

Check REST clients

The REST API integration requires to program the API in the element interacting with the BQN, for example a billing system. To test that the BQN REST configuration is correct, REST messages can be sent manually using curl Linux utility.

As an example, to create a policy named my_rest_policy_1and asssign it to a subscriber with IP 10.10.1.232:

curl -i -k -m 20 -u myuser:mypassword -X POSThttps://192.168.0.121:3443/api/v1/policies/rate/my_rest_policy_1 -H"Content-Type: application/json" --data'{"rateLimitDownlink": {"rate": 1000,"burstRate": 2000}, "rateLimitUplink": {"rate":500, "burstRate": 1000}}'

‍

Check the REST API

Once the policies and subscriber associations are created, the table Status->Radius/REST->Policies will show the policies coming from REST. For example, the next table show two policies, with two subscribers each. For the time being, there is no active subscriber (with traffic) with those policies:

Note that there are two active subscribers, without a REST policy and that have a static policy defined in the BQN (rate-default in this example).

To see the list of subscribers with REST policies, select Status->Radius/REST->Subscribers. The next example shows four subscribers and their associated policies:

The subscribers get a policy when the REST message isreceived. When the subscriber generates traffic, it will appear in the list ofactive subscribes in Status->Subscribers.

If a digital certificate is needed in the BQN

Sometimes, the REST clients need a specific digital certificate to validate the access.

Log as root to BQN Unix shell and copy the certificate and its key in the following files:

/bqn/root/etc/ssl/certs/bqn.crt
/bqn/root/etc/ssl/private/bqn.key

(you can use scp to transfer previously the certificate files to the BQN server).

To apply the change, reboot the BQN server in Administration->Reboot.

‍

‍

‍

‍