Basic API Getting Started

1. 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.

2. Functional Range

The following functions are currently available in the Sedo API:

2.1 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 master keywords
• Enable / disable elements on a parked page
• Set / Reset parking templates
• Check blacklist

2.2 Search Related Functions

• Extensive search for domains which are for sale at Sedo

3. Interface Description

The Sedo interface is accessible via SOAP which you can use to execute RPCs.

A description of the Sedo interface in WSDL format can be found at the following URL:

https://api.sedo.com/api/v1/?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.

4. Request Format

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 must be encoded in UTF-8.
• IDN domains (e.g. sedoköln.com) must be encoded in ACE (e.g. xn--sedokoln-e1a.com).

5. Response Format

5.1 Success Responses

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 encoded in UTF-8.
• IDN domains are encoded in ACE.

5.2 Error Responses

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

Unique error code which identifies exactly which type of error has occurred. See Faultcodes & Faultstrings for more information.

Fault String

Brief description of the error.

6. Working with SOAP

6.1 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 the PHP examples, we used PHP's native SOAP extension.

For the Java examples, we created Stub classes from the WSDL file using the Apache Axis library.

6.2 Using PHP's native SOAP extension

Example (PHP 7):

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