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.
Every user can use the XML interface without additional activation.
The SSL Manager API has the following basic request types:
Requests contained in the SSL Manager API have a general structure to them.
For a detailed explanation of the keywords, see the request component.
<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>
SSL Manager API responses have the following structure:
For a detailed explanation of the keywords, see the response component.
<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>
|"S" and code of the request type||S400101||S (Success) = Request was successfully received.|
|"E" and code of the request type||E400101||E (Error) = An error occurred.|
|"N" and code of the request type||N400101||N (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.