Inhaltsverzeichnis dieser Seite

Schnittstellen-Adressen

Freischaltung

Jeder Benutzer kann die JSON-API ohne zusätzliche Freischaltung nutzen.

Limits

Es können nur 3 Anfragen pro Sekunde pro IP gesendet werden.

Systemantworten

Die Systemantworten in der JSON-Schnittstelle haben immer den gleichen Aufbau:

  • status: Der Status des Restcalls.
  • stid: Die eindeutige vom System zugeordnete Transaktions-ID.
  • object: Das Objekt des Auftrages.
  • data: Der Datenblock der die angefragten Daten enthält. Hierbei handelt es sich um eine Liste mit 0-n Elementen.
Standardantwort
{
    "status": {
        "code": "S0301",
        "text": "Lorem ipsum dolor sit amet, noster menandri efficiantur eos eu.",
        "type": "SUCCESS"
    },
    "stid": "20180915-app1-201411",
    "object": {
        "type": "contact",
        "value": "100101"
    },
    "data": [
        {
			...
        }
    ]
}

Aufbau der Routen

Die JSON-API kennt fünf Auftragstypen:

  • Create: Erzeugen eines Objektes
  • Update: Änderung eines existierenden Objektes
  • Delete: Löschen eines existierenden Objektes
  • Info: Einzelabfrage eines Objektes
  • List: Listenabfrage auf eine Gruppe gleicher Objekte

Die URLs für die Restcalls sind nach folgendem Schema aufgebaut:

  • Create: POST /objectgruppe
  • Update: PUT /objectgruppe/$identifier
  • Delete: DELETE /objectgruppe/$identifier
  • Info: GET /objectgruppe/$identifier
  • List: POST /objectgruppe/_search

Für viele Objektgruppen gibt es zusätzliche Routen, die andere Auftragstypen im System ansprechen. Diese sind in der technischen Dokumentation beschrieben.

Swagger-Dokumentation

Für die JSON-Schnittstelle gibt es eine technische Dokumentation nach dem OpenAPI 2.0 Standard. Für die weitere Verwendung der OpenAPI-Dokumentation ist diese im InterNetX Github Repository verfügbar.

Verbindungstest

Ein Verbindungstest erfolgt über die Route GET /hello. Die Route führt keine Operation aus und dient nur dem Verbindungstest.

Login und Authentifizierung

Die AutoDNS JSON-API bietet die Authentifizierung über eine Session-ID und über BasicAuth an.
Für die korrekte Nutzung der JSON-API ist die Verwendung eines User Agents zwingend erforderlich.

Systemantworten und Systembenachrichtigungen

Die in Echtzeit versendeten Systemantworten enthalten im Tag <status> Informationen über den Status des Auftrags. Dies sind "S" (success) bei erfolgreicher Auftragsverarbeitung, "E" (error),  wenn die Verarbeitung nicht erfolgreich ausgeführt werden konnte und "N" (notification), wenn der Auftrag angenommen wurde und noch weitere Verarbeitungsschritte nötig sind.

Auf "N" folgen zeitverzögert Systembenachrichtigungen die den letztendlichen Status der Verarbeitung anzeigen , "S" oder "E".  Sie können per Push oder Polling abgerufen werden oder werden per E-Mail versendet. Die Dokumentation finden Sie hier.

Listenabfragen

Die API bietet die Möglichkeit komplexe Listenabfragen durchzuführen.

Prozessbeschreibungen

Der Bereich API-Prozesse enthält Schritt-für-Schritt-Anleitungen für verschiedene Domain- und Zertifikats-Prozesse, um dich bei der Implementierung der Domain-Robot-API zu unterstützen.  Jede von ihnen beschreibt,  wie ein Prozess automatisiert werden kann und enthält entsprechende XML- und JSON-Beispiele.