JeraSoft Documentation Portal
Docs for all releases
The Management API allows you to easily integrate 3rd party applications with VCS platform. It may be accessed using either XML-RPC or JSON-RPC. Both are fairly standard protocols for remote procedure calls.
Most programming languages have libraries to work with any of these protocols. The API uses the same logic as the web interface and works very similar, which makes its usage easier.
To access XML-RPC interface use:
To access JSON-RPC interface use:
Before accessing the system make sure that your IP is allowed on the firewall. Also, please make sure that rest of the world is blocked by firewall. You can get more details about it in the JeraSoft Billing First Steps.
Starting from the VCS 3.13, the XML-RPC protocol will be considered as deprecated. We strongly recommend using the JSON-RPC protocol that provides the same functionality. Please note, the support of the XML-RPC protocol will be completely removed in the VCS 3.14.
In order to make any request to the API, you need to authenticate using login and password.
We strongly recommend having separate API account for each application you make calls from. Besides this, we recommend having dedicated Role for API users, which allows only needed actions. Authentication is done by sending the following array along with other arguments:
In order to increase performance you may not authenticate for each call but do it once and save Session ID given back to you in response.
This Session ID may be sent in further requests instead of login and passwords to continue using the same session without re-authentication. Session ID should be sent with other arguments in the following format:
It should be mentioned that authentication should be made within the first call to the API.
Each request besides authentication information should include:
|Method Name||Name of the module and action to call|
|Arguments||List of arguments for the method call|
id_clients = 11
auth[login] = admin
auth[password] = password
Each response will include the following information:
|Return code, usually true on success or false on failure|
|Array with data returned by method|
[client] => Array
|session_id||Session ID which may be used to speed up next calls|
|messages||List of success / warning messages returned by message|
|errors||List of abnormal errors if they fired during processing|
There is a specific case when your request to the billing should provide file response. For example, it could be an invoice file download, CDRs List download, etc. Using plain XML-RPC or JSON-RPC with base64 on top of it is not effective here as the file may contain hundreds of megabytes. This special case is handled with common HTTP Request to:
The request may be either GET or POST and should include either Login and Password or Session ID. In response, the server will send the file according to HTTP protocol.
For you convenience, it is always better to have higher level class on top of the simple RPC protocol. You can download an example of such class for PHP. Below is example:
To download a sample library for Python, please visit /usr/local/vcs/lib/pycore/tools/vcsapi.py. It will simplify work with API. You can find an example below:
At the moment we are working hard to bring you a full and detailed list of methods, arguments and expected output. However as API fully duplicates web methods, it is easy to find their names and arguments yourselves. Let's check a quick example, like creating a reseller.
In the web interface the link to this action is "https://<your-billing-IP>/admin/companies/add", with "companies" being a module and "add" being a method.
The resulting method to call via API is "companies.add".
In order to find out arguments for this method, you may look for HTTP request in your browser (using FireBug in Firefox, Developer Tools in Chrome). Another way is to check for dump in /opt/jerasoft/vcs/core/pycore/tools/runtime.log which looks like:
This log entry includes the full list of the arguments used. However many of them are optional. Try calling the method with the arguments you need and the system will let you know if you are missing any of the arguments.
The JeraSoft team may modify the attributes and methods related to the Management API usage from time to time without advance notice.