Search in this section
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.
Standard Request Types:
The SSLManager API has the following 5 basic request types:
- Create-Task : Creating an object.
- Update-Task : Changing the information of 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 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
- Result
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 | Example | Description |
---|---|---|
"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. |
Differences between Status-Codes and Error-Codes
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.