Gandi XML API FAQ

Frequently Asked Questions about the Gandi API.

What is XML RPC?

XML-RPC (Remote Procedure Call) is a remote access procedure using HTTP as the transportation means, and XML as code.

XML-RPC is known for being as simple as possible, while allowing for complex data structures to be sent, processed, and returned. It is to be noted that Gandi uses HTTPS protocol for increased security.

You will find more information available on this topic on the official XML-RPC website at http://www.xmlrpc.com/

What is an automated XML-RPC interface?

An automated XML-RPC interface is a system that allows you to access resources via XML-RPC commands that are inserted on the website or in an application.

How does the Gandi API XML interface work?

The command interface provides a range of XML-RPC methods allowing for the automatic processing of domain name management commands.

Therefore, you may purchase, renew, transfer a domain, or even change a DNS configuration or forwarding, without having to log into Gandi's website.

Complete documentation of all available methods is visible at this address: http://doc.rpc.gandi.net/

Who can use Gandi's Domain, Email, and Hosting API XML?

All Gandi customers may have access to Gandi's API XML. This product mainly targets web hosts or resellers that would like to provide their customers with the possibility of purchasing or managing their domain on their own interface. The payment of orders occurs via a prepaid account.

For more on this visit: http://www.gandibar.net/post/2012/01/06/New-Domain-Name-and-Email-API

How does one set up Gandi API?

To activate the Gandi API for use, simply follow these instructions.

What programming languages allow connecting via XML-RPC?

Many languages offer the possibility of using XML-RPC quite easily, either through libraries or via direct functions. Only a few lines of code are necessary for purchasing a domain name.

For example:

  • Python: The xmlrpclib module distribution comes bundled with all that you need to use Gandi API XML.
  • Perl: the CPAN SOAP::Lite module includes the XMLRPC::Lite package which manages everything you need right out of the box.
  • PHP: there are several libraries that you can use for connection, such as http://phpxmlrpc.sourceforge.net/ or http://pear.php.net/package/XML_RPC/ , PHP5 also contains a library.
  • C or C++: you may connect via the library available at this address: http://xmlrpc-c.sourceforge.net/

The full list of XML-RPC commands is available at xmlrpc.com

How does the OT&E test environment work?

The OT&E test environment is a permanent virtual environment that allows you to test your XML requests. This environment is a “parallel web” in which the domains you own and the contacts you manipulate don't exist.

Last modified: 06/02/2015 at 16:00 by Jonathan G. (Gandi)