Sedo API

Introduction

The Sedo API enables you to access the Sedo database from your own applications. For example, you can download your domain parking statistics and easily import them into your own analysis program / tools. You can also manage your Sedo domain portfolio and search the Sedo database for domains for sale.

Sedo uses the SOAP and WSDL standards in order to allow an implementation in your favorite environment e.g. Java, Perl, PHP or .NET.

The Sedo API is currently in the beta test phase. Nevertheless, all functions available to you in this version of the API have been thoroughly tested and will remain in their current form in future. This ensures that your programs will continue to be compatible with future versions of the API.

We welcome your feedback, any suggestions you may have for further functions that we could include in the API, or information about any bugs you may find in the API at contact@sedo.com.

Functional Range

The following functions are currently available in the Sedo API:

Customer-related functions

  • Set up a new customer account
  • Request details of an existing account
  • Edit existing customer account
  • Change account password

Domain-related functions

  • Enter a domain for sale and/or into the parking program
  • Check if a particular domain is for sale at Sedo
  • Access parking statistics
  • Get/Set keywords: This feature allows you to set up to 50 master keywords at once and then manage them
  • Enable/disable elements on a parked page
  • Set/Reset template
  • Check blacklist

Search-related functions

  • Extensive search for domains which are for sale at Sedo

Interface Description

The Sedo interface is accessible through the Simple Object Access Protocol (SOAP) which you can use to make Remote Procedure Calls (RPC). A description of the Sedo interface can be found at the following URL:

https://api.sedo.com/api/sedointerface.php

The corresponding WSDL file can be found at:

https://api.sedo.com/api/sedointerface.php?wsdl

For most functions, the documentation contains examples including both PHP and Java source code.

You can find further links on working with SOAP and WSDL at the end of the introduction.

Communicating with the Sedo API

Request to the interface

The client sends a request for a specified function to the API. Before this can be done, however, the transferred data must be converted into the correct format. All data sent has to be UTF-8 encoded.

e.g.: Müller should be transferred to the functions as Müller

IDN domains (domains with special characters) should be transferred in Punycode format.

e.g. sedoköln.com should be transferred to the functions as xn--sedokoln-e1a.com

Response from the interface

If successful

Depending on the requested function, the interface will send back various types of values. The types of value returned by the interface are described in the documentation for each function.

The interface returns data in the following format:

  • All strings are UTF-8 encoded.
  • All IDN domains are in Punycode format.

If you work with UTF-8 on your system or if you don't send us any strings with special characters, you do not have to decode the data we send you. In all other cases, you will need to convert the data we send you into the encoding used by your system (e.g. ISO-8859-1) before you can process it further.

If unsuccessful

If the parameters sent with a request do not correspond to the function's specifications, the interface delivers an error message as an array. The fields of the array are always the same and contain the following information:

  • Fault code – The error code is unique to the system and serves to identify exactly which type of error has occurred. If you need support for an error, please make absolutely sure that you include the error code in your support request.
  • Fault String – The field contains a brief description of the error.

Further information on SOAP and WSDL

What is SOAP?

SOAP is a protocol for exchange of information. Communication in SOAP is based on transferring messages written in XML. The SOAP message is sent from a SOAP client to a SOAP server by means of various protocols (e.g. HTTP). The XML message makes it possible for different operating systems with different programming languages and technologies to exchange messages with each other.

The documentation contains examples in both PHP and Java for each function on offer.

For the PHP examples, we used the nusoap.php class ( Sourceforge Project Site ).

For the Java examples, we created Stub classes from the WSDL file and used this off line. We used the Apache Axis library ( http://ws.apache.org/axis/ ) to create the Stub classes.

Using nusoap 0.7.3 with PHP 5

In order to use nusoap with PHP5 you require version: 0.7.3.

With this version, there has been a important change to the programming of a client. In the documents we give examples in PHP with the line:

$client = new soapclient('https://api.sedo.com/api/sedointerface.php');

With PHP 5 this call will produce an error. In order to avoid this error occurring, this line should be changed as follows:

$client = new nusoap_client('https://api.sedo.com/api/sedointerface.php');

Using the internal PHP 5 SOAP module

In version 5, PHP has integrated an internal module. So that a client can be created, the following changes should be taken into account:

$client = new SoapClient(
    NULL,
    array(
        'location' => "https://api.sedo.com/api/sedointerface.php",
        'soap_version' => SOAP_1_1,
        'encoding' => 'UTF-8',
        'uri' => 'urn:SedoInterface',
        'style' => SOAP_RPC,
        'use' => SOAP_ENCODED
    )
);