Table of Contents

Interface Addresses

Live system: https://api.autodns.com/v1
Demo system: https://api.demo.autodns.com/v1

Activation

Every user can use the JSON API without additional activation.

Limits

Only 3 requests per second and IP can be executed.

System Responses

The system responses in the JSON interface always have the same structure:

  • status: the Restcall status
  • stid: the unique transaction ID assigned by the system
  • object: the object in the request
  • data: the data block containing the requested data. This is a list with 0 - n elements.


Default Response 
{
    "status": {
        "resultCode": "S0301",
        "text": "Lorem ipsum dolor sit amet, noster menandri efficiantur eos eu.",
        "type": "SUCCESS"
    },
    "stid": "20180915-app1",
    "object": {
        "type": "contact",
        "value": "100101"
    },
    "data": [
        {
			...
        }
    ]
}

Structure of the Routes

The JSON API knows five request types:

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

The URLs for the various Restcalls are structured according to the following schema:

CREATE = POST /object group
UPDATE = PUT /object group/$identifier
DELETE = DELETE /object group/$identifier
INFO  = GET /object group/$identifier
LIST = POST /object group/_search

For many object groups, there are additional routes that address other order types in the system. These are described in the technical documentation.

Swagger Documentation

For the JSON interface there is a technical documentation according to OpenAPI 2.0 standard. For further use of the OpenAPI documentation it is available in the InterNetX Github Repository.

Connection Test

A connection test is performed via the route GET /hello. The route does not perform an operation and is only used for testing the connection and authentication credentials.

Login and Authentication

The AutoDNS JSON API provides authentication via a SessionID and BasicAuth.
The use of a UserAgent is mandatory for the correct use of the JSON API.

System Responses and System Notifications

The system responses sent in real time contain information about the status of the order in the <status> tag. These are "S" (success) if the order was processed successfully, "E" (error) if the processing could not be executed successfully and "N" (notification) if the order was accepted and further processing steps are still necessary.

N" is followed by time-delayed system notifications indicating the final status of the processing, "S" or "E".  They can be retrieved by push or polling or are sent by email. The documentation can be found here.

List Inquiries

The API offers the possibility to perform complex list inquiries.

Process Descriptions

The API Processes section contains step-by-step instructions for various domain and certificate processes to help you implement the Domain-Robot API.  Each of them describes how a process can be automated and includes corresponding XML and JSON examples.