Connect to the API
How to send requests to the API server
To communicate with our API server, post the XML code corresponding to the action you want to execute to a specific URL. This URL can either be the URL of our test environment or the URL of our production environment.
The XML code has to be encoded twice to contain only URL safe characters and must be sent using the HTML POST method. Please note that for security reasons, every request requires your authentication (login and password).
Send the password either in plain or MD5 format. If you send the password in MD5 format, it has to be preceded by the characters MD5 (For example: MD5A19f4d26e3c536b5dd871bb2c52e3178).
Please note that for security reasons the number of simultaneous requests to our API server is limited. Default limitations are 2 requests per second with a burst limit of 8 requests. You may, therefore, either send 2 requests each second or send 8 requests within a second and then wait 3 more seconds before sending another request. If you exceed these limitations, the API server will accept no more requests from your IP address. In this case, please wait a couple of minutes before sending another request to our server.
We provide you a test environment to give you the possibility to test your scripts before launching them on the production server. The test server behaves exactly like the production server with the exception that all actions are free of charge and only simulated.
If you register for example a new domain on the test server, we will not forward this request to a registry and the domain will thus not be registered for real. To simulate the registration proces, the same domain will however be stated as taken if you check its availability on the test server.
As actions on the production server cannot be undone, it is highly recommended that you test your scripts on the test server before switching to the production environment. Please note that your login and your password may differ from one environment to the other.
We invite you to have a look at our PHP example of the API usage for an example how to switch easily between both environments.
Send a request using ...
- ... the PEAR class HTTP_Request
- ... only buildin functions
- ... PHP cURL
|The element is optional and does not have to be specified in the request and/or answer
|The element is mandatory and has to specified in the request and/or answer