Introduction

At the end of this article, you will be able to utilise our API methods to automate billing tasks. Should you need any assistance, feel free to contact our support department.

Authentication & API methods

API integration is the connection between two or more applications via APIs, which allow the systems to exchange data. By using this feature, you will be able to integrate your phone system to CRMs, management software, and other systems. To configure the API integration, firstly, click on the "Integration/API" tab and select the API option from the left-hand menu. To locate and protect your account in our system, an API key is generated. Copy and paste this API key into the header of your API request. Further, as an extra security layer, add the public IP where the API request is coming from by clicking the button "add IP" to have it whitelisted. Please note, you must list the IP from which the API request comes, otherwise, 401 - Not authorised response will be sent. The image below shows the current methods supported by our system, they are:

GET method:

• Get customer balance for a determined period
• Get partner balance for a determined period

PUT method:

• Move funds between partner and customer

POST method:

• Register a new customer
• Confirm customer's email
• Log in to customer's account via URL
• Reset customer's password

Configuring API integration

Taking the GET customer balance as an example, firstly, copy the API key from either the API key field or header value.

Next, paste the API key into the header of the GET request. The key should be "token", and its value is the API key.

Head back to the admin portal, enter the parameter according to your requirements; initial and final date, and the customer account number. Lastly, copy the full URL request including the parameters and paste it onto your GET request.

In case of success, you should receive a similar response to the following example:

{
"code": 200,
"data": {
"opening_balance": 245.71293,
"payments": 57,
"adjustments": 5,
"call_charges": 48.125,
"other_charges": 7.5,
"total_charges": 60.625,
"closing_balance": 242.08793
}
}

Following that, if you wish to move funds from or to your partner account, add the API key to the header of the PUT request. Then, copy and paste the request URL from the partner portal into your API request, and complete the required fields; account number, amount, and description. Please note that these parameters must be sent in the multipart or form-data format. Additionally, the variables that our system is expected can be found next to the parameter name, e.g. Account number - account_number . A successful response would be similar to the following example:

{
"code": 200,
"data": {
"customer_balance": 242.08793,
"customer_credit_limit": -55
}
}

Lastly, note that for POST methods, a new security layer has been added: GoogleReCAPTCHA field. Please refer to Google's documentation to set it up and add the variable "google_captcha" to your API request. Also, the response code description can be found at the bottom-right corner of the Integrations/API tab.