API Documentation


CDP Advanced and Enterprise editions include API (Application Programmer Interface) options. API can be used by developers who need to integrate a CDP Enterprise or Advanced edition into their existing billing or provisioning system.


The CDP Server API uses SOAP (Simple Object Access Protocol), which is the industry-standard for integrating web services applications.

SOAP messages use the language chosen by the authenticated user. If no language is chosen, or the chosen language is not installed, then the messages use the CDP server's default language. If there are problems with the CDP server's default language, English is used as the default language for SOAP messages.


You can use soapUI to create and execute automated functional, regression, compliance, and load tests. soapUI is a free, open-source, cross-platform functional testing solution. In a single test environment, soapUI provides complete test coverage and supports all standard protocols and technologies. You can download soapUI 4.5 open-source here: http://sourceforge.net/projects/soapui/files/. Read more: http://www.soapui.org.

API Documentation

You can access the API Reference Documentation in <CDP_URL>/apidoc. The documentation describes classes, structs, unions, and interfaces. See details in Accessing API Documentation.

Sample Scripts

CDP installation includes:

You can find PHP sample scripts for API calls for the following customer types:

You can access scripts in /usr/sbin/r1soft/apisamples.
Read more in Accessing Example API Functions.

In addition to PHP scripts, R1Soft supplies XML scripts for soapUI.

The current soapUI script works only for CDP servers installed on Windows. See Running soapUI Script on Linux.
Section Content