API

LightBulb Software™ → Products → BlissRADIUS Embedded™ → Manual → API

API

BlissRADIUS Embedded provides external API by using HTTP GET or POST requests to query state or issue commands. Client can be browser or software written in any programming language. API calls are executed by making web request to http://localhost:9071/api (change address in URL to location of your server) with required argument action like:

http://localhost:9071/api?action=myaction&param1=foo&param2=bar

API calls can be executed only:

By admin's web browser used to login to web interface using password.
By any kind of program or client accessing from one of trusted IP addresses (localhost address is always trusted).
By any kind of program or client sending request that includes local API secret as "secret" POST or GET variable (extra security measures like HTTPS must be in place if requests are going over unsecured network).

API calls return output as UTF-8 encoded text. If call is a successful, output will start with SUCCESS\n (with trailing new line) followed by response data. Failure will start with ERROR\n (again trailing new line) followed by message describing error.

Response content may be plain text, HTML or JSON encoded data, depending on call.

Example

To query which version of BlissRADIUS Embedded is running open following URL in your browser:

http://localhost:9071/api?action=version

Received success output would be:

SUCCESS
0.4.12-win32

Failed call, due to lack of privileges because request came from IP address that is not trusted, will return:

ERROR
API call from 192.168.1.10 is not permitted

System calls

These calls are used by host software for two way communication and as such third party programs might have little use of them (unless you are customizing your billing software to work with BlissRADIUS Embedded):

version - returns full version of running program as string.
engine - used to update host software files required for BlissRADIUS Embedded integration. Usually returns PHP source code (WHMCS, Blesta), depending on host type. Arguments:
- host (string, optional) - test for correct host type (as found as hosttype in blissembed.cfg) and raises error if it doesn't match.
empty_cache - empties cache used for quick service lookup, forcing reload on next lookup. Additional arguments are used to narrow down which services are to be removed. If no arguments are provided then cache is emptied completely and all services reloaded. If delete is not enabled services are only marked as expired and not physically deleted.
- service_id (integer, optional) - exactly match service by ID.
- product_id (integer, optional) - match all services by product ID.
- client_id (integer, optional) - match all services owned by client ID.
- username (string, optional) - exactly match service by username.
- delete (boolean 1 or 0, optional, default 0) - if enabled then physically delete matching services from cache. There usually is no reason to do this explicitly.
html_status - returns HTML code of status bar for injecting in host admin portal.
- url (string, required) - full URL to BlissRADIUS Embedded web portal, used for login link.
html_service_admin - returns HTML code of service details for injecting in host admin portal.
- id (integer, required) - ID of service to display stats for.
html_service_client - returns HTML code of service details for injecting in host client portal.
- id (integer, required) - ID of service to display stats for.
html_options_picker - returns HTML/JavaScript code that makes configuration of Service options more friendly. This won't work without JavaScript enabled in browser. Before HTML code is injected into web page make sure blissembedOptionsTextarea JavaScript function is defined and that it returns textarea input field used for editing (eg. as return value of HTML DOM document.getElementById() method) example:
```
<script>
function blissembedOptionsTextarea(){
    return document.getElementById('my_textarea')
}
</script>
```

User calls

These calls are useful when connecting BlissRADIUS Embedded with third party software.

service - returns JSON encoded service details about usage, quotas, top-ups, sessions etc. Data is same as shown by html_service_admin.
- id (integer, required) - ID of service to display stats for.
disconnect - disconnects online sessions that match filter. Exactly one filter must be provided. Call will send disconnect requests for all matching sessions and will return success only if all are disconnected.
- id (integer, optional) - integer primary key of online session as found in database table.
- service_id (integer, optional) - exactly match sessions by service ID.
- username (string, optional) - exactly match session by username.

2025-03-16: Referral program is active, existing users can win bonus license time if they bring new customers in.
2025-03-02: BlissRADIUS Embedded™ 1.16 is out with new features.
2024-09-27: BlissRADIUS Embedded™ 1.15 is out with postpaid license support.
2024-09-19: We are introducing changes to payment methods. See Home page for more details.
2023-07-06: BlissRADIUS Embedded™ 1.14 is out with new features.
2022-11-18: BlissRADIUS Embedded™ 1.13 is released with new fixes and features.
2021-12-31: BlissRADIUS Embedded™ 1.12 is out with new features.
2021-06-22: Volume discount for monthly BlissRADIUS™ licenses is available now.