Application Programming Interface¶
An API (Application Programming Interface) allows for more intricate control over your system. It's either through customization or the use of third-party applications.
ConnexCS has two distinct APIs. Each is accessible through a different URL, but both follow the same specifications.
The API is Restful JSON accessible over HTTPS. It makes distinctions about GET
, POST
, PUT
and DELETE
and follows CRUD (CREATE, READ, UPDATE, and DELETE).
Requests take advantage of request variables, while JSON Documents may sometimes post where they require a more complex request.
A JSON Document will always be returned and HTTPS Layer handles the errors.
Switch Administration¶
The switch API provides full administrative capabilities.
This means that every function accomplished through our web interface is available through our API.
You can find the API specification here: https://docs.connexcs.com/cp-api
Customer Administration¶
The API lets you perform customer-facing operations like communicating with the switch, information about current balances, and managing Call Detail Records (CDRs).
You can find the specifications for the customer-facing API operations here.
To view supported integrations, go to API Integrations.