Introduction

The beroNet VoIP Gateways and Cards have a REST based API, which can be used to:

• get information and statuses
• trigger actions
• set configurations

The API has evolved between the Firmware Versions  3.XX and 16.XX. The "old" API is called via the URL

http://172.20.5.10/app/api/beroFix.php

The New API has a new URL:

http://172.20.5.10/app/api/api.php

When calling one of these URLs you will be requested to authenticate yourself. By default the Api-Username is "admin" and the passwort is "admin" too. 

We have built the API to be pretty much self-documentary. When you call above URLs on your devices a HTML Page with a list of API calls will appear. When you click on an API call, you will receive a brief documentation on what this API call does, how it is used, what kind of parameters it accepts or requires and what it will return. 

Most API calls can be called directly with the browser, which makes it easy to test. 

Automating API requests

The API calls can be simply automated with the wget commandline tool. The following example shows how to get the API Version:

wget --user=admin --password=admin -O - "http://172.20.5.10/app/api/api.php?apiCommand=ApiGetVersion" 2>/dev/null
 
ApiGetVersion:success:4.0

In pinciple most API commands can be called via wget and thus be automated in a script.