Skip to end of metadata
Go to start of metadata

Several configuration APIs allow you to manage the system, users, devices and features.

Configuration APIs exist in both SOAP and REST protocol formats and are mutually exclusive of each other. It is however possible to use both formats in conjunction depending on what you are aiming to achieve.
Not all of what is available from the Configuration Administration Web interface or the User Web Portal is available for extensions using web services. If an API does not exist, you have the possibility to create one to suit your needs.

If expanding the API is not an option for you and you need access to certain functionality, sipXcom offers you the possibility to manage that. The majority of the administration and user interfaces in sipXcom have unit tests that automate link clicks, form submissions and button presses using a standard HTML parsing library. Most programming languages have similar libraries often based on the cURL package (for example: php_curl). This method does not require you to find a parsing library that interprets JavaScript.

In addition, the HTML that is returned makes common use of the HTML ID attribute to uniquely identifiable key parts of the page to the unit tests. These same IDs can be found by XPath or even XML DOM navigation parsing libraries fairly easily.

If you decide to go this route, consider expanding on the Web Service APIs as well and submitting your changes back to sipXcom upstream. Web pages are subject to change and do not constitute a stable API like the Web Service APIs would.

The result of the queries are description in JSON and/or XML format.

  • No labels