Suche in diesem Bereich
Every user can use the JSON API without additional activation.
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.
Structure of the Routes
The JSON API knows five request types:
- Create: Create an object.
- Update: Modification of an existing object
- Delete: Delete 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.
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.
A connection test is performed via the route GET /hello. The route does not perform an operation and is only used for the connection test.
Meaning of Status Types and Status Codes
The system responses contain information about the request status in the tag <status>.
|success||S400101||S (Success) = Request was successfully accepted.|
|error||E400101||E (Error) = An error has occurred.|
N (Notification) = For some tasks, 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 (see Asynchronous Notifications).
Status Codes and Error Codes. What is the difference?
Status codes always start with an S, E or N and describe the status of the job. Error messages start with an EF and describe the error that occurred.
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 notifications are asynchronous notifications that inform you about the status of an order. They are sent with a time delay because other instances, such as a registry, are involved in the processing of the process.
The API offers the possibility to perform complex list inquiries.
For the JSON interface there is a technical documentation according to OpenAPI 2.0 standard. The OpenAPI documentation is available in the InterNetX Github Repository for further use.
The API Basics 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.