Summary of the API
The API provides access for other programs to all Hosting Reborn features, exposing sufficient functionality to build anything up to your own web hosting service.
Any program capable of making HTTP requests and understanding XML can directly access any feature provided by the Hosting Reborn web site.
Requests are made to the API to retrieve or store information. Successful responses will be met with relevant XML-structured data. Abnormal operations (such as a failure to connect to the database) will return XML-structured exceptions.
You may make 10,000 requests per IP address per month without charge.
Specification
Requests
- Read requests (those that retrieve data) must use the HTTP GET method
- Write requests (those that store data) must use the HTTP POST method
- Request URLs are always lowercase
-
Multi-word functions are always underscore-separated, for example
/price/get_bandwidth/and not/price/getBandwidth/or/price/getbandwidth/ - Values passed to the API must be URL encoded
- Arguments names are always lowercase
Responses
- Requests are met with HTTP responses
- The body of a response will always contain XML-structured data
- The response body will contain either relevant data or an exception.
- XML version 1.0 is used
- XML-response values are always UTF-8 encoded
- XML-response element names are always 7-bit ASCII a-z only
- XML-response element names are always lowercase
Do not use undocumented features
You may occasionally find some things that work that aren't officially documented. These might be unlisted functions or the behaviour of certain data types.
Do not use any undocumented functions or rely on any undocumented behaviour. Functions may slip into the API in relation to experimental features or for live testing that cannot be performed in a development environment. Unofficial behaviours may be benign side-effects of how certain operations are performed or may be due to faults that will subsequently be fixed.
If you find something that appears to work but which is not documented please contact us before using it. What you are observing may be a fault that needs fixing. Conversely, it may be an official feature that failed to get a mention in the documentation. The point is that you can't tell which is the case.
If you rely on undocumented features, your application may no longer function in the same fashion should the undocumented features be modified or removed.