Skip to end of metadata
Go to start of metadata

Configuration APIs exist in both SOAP and RESTful protocol formats and are mutually exclusive of each other. Which API has which functionality mainly depends on when the API was implemented so you'll need to check both APIs for your desired functionality. You may even possible might need to use both in conjunction depending on what you are trying to do.

Configuration system drives a lot about the system and abstract the details about what systems or devices need updating, restarting or activation.

Not all of what is available from the Configuration Administration Admin Web interface or the User Web Portal is available from a web services. If you find an API is missing, please consider expanding on the API.

If expanding the API is not an option for you and you really need access to certain functionality there may still be an option for you. As it turns out, the majority of the administration and user interfaces in sipXecs 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 off the curl package (e.g. php_curl). You will not need to find a parsing library that interprets javascript however. In addition, the HTML that is returned makes common use of the the "id" HTML attribute to uniquely identifiable key parts of the page to the unit tests. These same ids can be found by xpath or even DOM navigation XML 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 sipXecs upstream. Web pages are subject to change and do not constitute a stable API like the Web Service APIs would. This means you'll want to replace your screen scraping scripts with proper web services calls before too long.

  • No labels