API General Howto

From Openprovider API documentation

Revision as of 12:31, 13 April 2011 by WikiSysop (Talk | contribs)
Jump to: navigation, search

API server

API commands should be sent over SSL to our API server on https://api.openprovider.eu. Each API command is an XML string that contains the data required for the respective command. The API will return an XML string to the sender, indicating the result of the command and optionally additional information.

PHP class for easy API inclusion

For easy integration in your existing system, Openprovider provides an example implementation in the PHP programming language. Other languages will follow in the future. The code provided consists of a wrapper class and an example implementation:

A more elaborated example is the following ZIP file, that contains a basic set of HTML forms that can be used to start your own online domain order form. Documentation is in the code, be sure to edit the config file before using the scripts. Note that the script will send registration requests realtime to your Openprovider account!

Other programming languages

In any other programming language, you can call the API by setting up a secured connection to https://api.openprovider.eu, and send the XML command over this connection. You will have to construct the XML command, and parse the XML response yourself.

Examples of the various API calls can be found in the description for each command.

Views
Personal tools