Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Inhaltsverzeichnis dieser Seite

Einführung

Das Backend der AutoDNS XML-Schnittstelle wird mittels XML-Kommunikation angesprochen. Jede XML-Anfrage (Request) wird auf Gültigkeit und das Vorhandensein erforderlicher Berechtigungen geprüft, verarbeitet und dann mit einer XML-Antwort (Response) beantwortet. In der XML-Antwort sind Informationen über den erfolgreichen oder nicht erfolgreichen Ausgang der Operation und ggf. angeforderte Daten enthalten (z. B. bei den Auftragstypen Info und List).
Je nach Auftragstyp wird der Auftrag synchron (realtime) über Daten aus der Datenbank oder mittels Kommunikation mit der Registry (asynchron) abgearbeitet.

Schnittstellenadressen

Freischaltung

Jeder Benutzer kann die Schnittstelle ohne zusätzliche Freischaltung nutzen.

Transport und Codierung

Der XML-Auftrag wird im HTTP-Content eines HTTP-Requestes an oben genannte URLs gesendet.

Der Content-Type ist application/xml

Das Encoding ist UTF-8.

Beachte bei der UTF-8-Konvertierung mit Microsoft.NET, dass der UTF-8 XML-String kein Byte Order Mark (BOM, de: Byte-Reihenfolge-Markierung) enthalten darf. Es wird standardmäßig ein Byte Order Mark an den Anfang des Strings gesetzt.

Limitierungen

Es können nur 3 Anfragen pro Sekunde und IP ausgeführt werden.

Bedeutung von Statustypen und Status-Codes

Die Systemantworten enthalten im Tag <status> Informationen über den Status des Auftrages.

TypBeispiel-CodeBedeutung
successS400101S (Success) = Auftrag wurde erfolgreich angenommen.
errorE400101E (Error) = Es ist ein Fehler aufgetreten.
notifyN400101N (Notification) = Bei manchen Auftragstypen erhälst du anstelle einer "Success"-  oder "Error"-Meldung zunächst eine" Notification"-Meldung.
Dies bedeutet, dass der Auftrag angenommen wurde und asynchron weiter verarbeitet wird.
Wenn der Auftrag vollständig abgearbeitet worden ist, wirst du per E-Mail, Polling oder Push über den endgültigen Status informiert.

Beispiel eines Statusblocks

XML
        <status>
            <type>notify</type>
            <code>N0101</code>
            <text>Die Domainregistrierung wurde erfolgreich gestartet.</text>
        </status>

Standardauftragstypen

Die AutoDNS XML-API kennt für Standardobjekte 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

Standardauftrag (Request)

Für Details siehe Systemaufträge (Request)

Aufbau

Ein Auftrag besteht aus einer Authentifizierung und einem oder mehreren Task-Blöcken.

request
      auth/authentication/auth_session (Authentifizierung)
      owner (Unterbenutzer)
       task (Auftragstyp)
            code (Auftragstyp)

XML-Beispiel

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>

Standardantwort (Response)

Für Details siehe Systemantworten (Response)

Aufbau 

Pro Task wird ein Result-Objekt zurück geliefert mit Angabe des Status.

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

XML-Beispiel

<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>