View Source

Server Backup Manager's API allows R1Soft partners to seamlessly integrate the product into existing billing or provisioning systems. In fact, you can do just about anything through the API that you can do through the Server Backup Manager interface, allowing you to tailor your end-user's experience with the system. Basically, the API allows for customization around the look and feel of the solution, the means by which the solution is accessed, and opportunities to integrate with third-party applications.

h4. API

Server Backup Manager includes *API* (Application Programmer Interface) options. Developers use API to integrate SBM into their existing billing or provisioning system.

h4. SOAP

The Server Backup Manager 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 SBM's default language. If there are problems with the default language, English is used as the default language for SOAP messages.

h4. soapUI

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: []. Read more: [].

h4. API Documentation

You can access the API Reference Documentation in {{<Backup_Manager_URL>/apidoc}}. The documentation describes classes, structs, unions, and interfaces. See details in [Access API documentation].

h4. Sample Scripts

The Backup Manager installation includes:
* *PHP scripts*
* *soapUI scripts*

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

* *Admin Only* \- All users logging into the Backup Manager are administrators (super-users).
* *Multi-Tenant with groups* \- Group-based administration (not recommended for service providers).
* *Multi-Tenant* \- User-based administration.
* *Tiered Reselling* \- User-based administration (customers can create their own users).

You can access scripts in {{/usr/sbin/r1soft/apisamples}}. Read more in [Access example API functions].

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


When using the API you must designate the type of user on the "user=" line as either _\--user=dcc/someuser_ or _\--user=sbm/someuser_. Otherwise, the user defaults to local users.


{info:title=Note}The current soapUI script works only for Server Backup Manager installed on Windows. See [cdp:Running SoapUI Script on Linux].{info}

{panel:title=Section Content}

{excerpt:hidden=true}General description of the Server Backup Manager API documentation.{excerpt}