Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Table of Contents

Introduction

The backend of the AutoDNS XML interface is addressed via XML communication. Every XML request is checked for validity and the existence of required authorizations, processed and then answered with an XML response. The XML response contains information about the successful or unsuccessful completion of the operation and any requested data (for example, for the Info and List tasks ).
Depending on the task the request is processed synchronously (realtime) via data from the database or via communication with the registry (asynchronous).

Interface Addresses

Activation

Every user can use the interface without additional activation.

Transport and Coding

The XML request is sent as a body of an HTTP request to the URLs mentioned above.

The content-type is application/xml.

The encoding is UTF-8.

When converting UTF-8 with Microsoft.NET, note that the UTF-8 XML string must not contain a byte order mark (BOM). By default, a byte order mark is set at the beginning of the string.

Limits

Only 3 requests per second and IP can be executed.

Meaning of Status Types and Status Codes

The system responses contain information about the status of the request in the tag <status>.

TypeExample CodeMeaning
successS400101S (Success) = Order was successfully accepted.
errorE400101E (Error) = An error has occurred.
notifyN400101

N (Notification) = For some types of jobs, instead of a "Success" or "Error" message, you will first receive a "Notification" message.

This means that the request has been accepted and is processed asynchronously. When the job has been completely processed, the user is informed of the final status by email, polling or push.

Example for a status block

XML
        <status>
            <type>notify</type>
            <code>N0101</code>
            <text>The domain registration was started successfully.</text>
        </status>

Default Tasks

The AutoDNS XML API knows five order types for standard objects:

  • CREATE
    Creating an object
  • UPDATE
    Changing an existing object
  • DELETE
    Deleting an existing object
  • INFO
    Single query of an object
  • LIST
    List query for a group of identical objects

Default Request

For details see page requests.

Structure

A request is made up of an authentication and one or more task blocks.

request
      auth/authentication/auth_session (Authentication)
      owner (subuser)
       task (task)
            code (task code)

XML Example

XML
<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <owner>
        <user>USER</user>
        <context>CONTEXT</context>
    </owner>
    <task>
        <code>CODE</code>
    </task>
</request>

Default Response

For details see page Responses.

Structure

For each task, one Result object is returned, each of which returns a status.

response (Root-Tag)
      result (Pro Auftragstyp ein Ergebnis)
            data
            status
            msg

XML Example

XML
<response>
    <result>
        <data>
            <object></object>
            <object></object>
        </data>
        <status>
            <type>success</type>
            <code>SXXXX</code>
            <text>TEXT</text>
        </status>
        <msg>
            <code>EFXXXX</code>
            <type>error</type>
            <text>TEXT</text>
            <object>
                <type></type>
                <value></value>
            </object>
        </msg>
    </result>
</response>