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

Gateway Addresses

Activation

Every user can use the XML interface without additional activation.

Standard Request Types:

The SSL Manager API has the following basic request types:

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

Standard Request

Requests contained in the SSL Manager API have a general structure to them.

  • Request
    • Authentification
    • Subusers
    • Task

For a detailed explanation of the keywords, see the request component.

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

SSL Manager API responses have the following structure:

  • Response
    • Result
      • Data
      • Status
      • Messages

For a detailed explanation of the keywords, see the response component.

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

ExampleDescription
"S" and code of the request typeS400101S (Success) = Request was successfully received.
"E" and code of the request typeE400101E (Error) = An error occurred.
"N" and code of the request typeN400101N (Notification) = Certain request types contain a "notification" message instead of the "Success" or "Error" message. This means that the request is being processed asynchronously. After this system message you will receive the final status by way of E-Mail or polling.

Status codes always begin with a S, E or N and describe the status of the request. Error codes begin with EF and describe the error that occurred.