You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »


Table of contents


Introduction

XML is used to "talk" to the SSL Manager backend. Every XML request is checked for validity and the associated required authorisation, processed by the system and returns a XML response. This XML response contains information about the successful or unsuccessful result of the request and/or may contains information about the requested details (for example inquire tasks). Depending on the request type, the request is processed using the information contained in the (realtime) database or by communicating with the CA (Certificate Authority) asynchronously.

Standard Request Types:

The SSLManager API has the following 5 basic request types:

  • Create-Task : Creating an object.
  • Update-Task : Changing an existing object.
  • Delete-Task : Deleting an existing object.
  • Info-Task : Inquiring information about a single object.
  • List-Task : Inquiring information about multiple objects which belong to the same object group.

Standard Request

Requests in der SSLManager API folgen einen grundsätzlichen Aufbau.

  • Request
    • Authentifizierung
    • Unterbenutzer
    • Task

Für eine genaue Beschreibung der Schlüsselwörter, siehe Request Komponente.

XML Example

Standard Request XML Example 
<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <owner>
        <user>USER</user>
        <context>CONTEXT</context>
    </owner>
    <task>
        <code></code>
    </task>
</request>

Standard Response

Responses in der SSLManager API folgen einem grundsätzlichen Aufbau.

  • Response
    • Ergebnis
      • Daten
      • Status
      • Nachrichten

Für eine genaue Beschreibung der Schlüsselwörter, siehe Response Komponente.

XML Example

Standard Response XML Example 
<response>
    <result>
        <data>
            <object></object>
            <object></object>
        </data>
        <status>
            <type></type>
            <code></code>
            <text></text>
        </status>
        <msg>
            <code></code>
            <type></type>
            <text></text>
            <object>
                <type></type>
                <value></value>
            </object>
        </msg>
    </result>
</response>

Status Codes and their meaning

Structure

ExampleExplanation
"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" Notification"-Meldung. Dies bedeutet, dass der Auftrag asynchron verarbeitet wird. Nach dieser Systemnachricht erhalten Sie per E-Mail oder Polling den endgültigen Status.


Differences between Status-Codes and Error-Codes

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

  • No labels