Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Inhaltsverzeichnis dieser Seite

Grundlagen

Schnittstellen-Adressen

Freischaltung

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

Antwort des Systems

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.

Verbindungstest

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

Status-Codes und ihre Bedeutung

Die Systemantworten enthalten im Tag status den Status des Auftrages.

AufbauBeispielBedeutung
"S" und Code des AuftragstypsS400101S (Success) = Auftrag wurde erfolgreich angenommen.
"E" und Code des AuftragstypsE400101E (Error) = Es ist ein Fehler aufgetreten.
"N" und Code des AuftragstypsN400101N (Notification) = Bei manchen Auftragstypen erhalten Sie anstelle einer "Success"- oder "Error"-Meldung zunächst eine Benachrichtigung, eine "Notification". Dies bedeutet, dass der Auftrag asynchron verarbeitet wird. Nach dieser Systemnachricht erhalten Sie per E-Mail oder Polling den endgültigen Status.

Unterschied Status-Code und Error-Code

Status-Codes beginnen immer mit einem S, E oder N und beschreiben den Status des Auftrags. Fehlermeldungen beginnen mit einem EF und beschreiben den aufgetretenen Fehler.

Weitere Informationen

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 UserAgents zwingend erforderlich.

Asynchrone Benachrichtigungen

Systembenachrichtigungen sind asynchrone Benachrichtigungen, die Sie über den Status eines Auftrages informieren. Sie werden zeitverzögert versendet, da andere Instanzen wie z. B. eine Registry in die Verarbeitung des Prozesses involviert sind.

Listenabfragen

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

Technische Dokumentation

Für die JSON-Schnittstelle gibt es eine technische Dokumentation nach OpenAPI 2.0 Standard. Zur weiteren Verwendung der OpenAPI-Dokumentation steht diese im InterNetX Github Repository bereit.

Prozessbeschreibungen

Der Bereich API-Prozesse enthält Schritt-für-Schritt-Anleitungen für verschiedene Domain- und Zertifikats-Prozesse, um Sie bei 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.