Ihr Browser lässt keine Web-Fonts zu. Unsere Webseiten nutzen Web-Fonts basierte Icons. Um unseren Service zu verbessern, erlauben Sie bitte Ihrem Browser Web-Fonts zu benutzen.
Wir stellen ein!
Deutsch | English | Español

Chapter 1. Overview

The communication is realized through XML-RPC and JSON-RPC (Remote Procedure Call) services. This is a specification by sending HTTP(S) requests to a assigned address. All client requests and server answers are using the XML or JSON format. The client must send the XML or JSON request via HTTP(S) POST and the server response is a XML or JSON document as well.

The first request must be an account.login command. In case of a succeded login you will receive a cookie session id in the header of the response. Please send it for all further requests.

1.1. XML format for API requests

The addresses of the provided services are:

  • for the test environment https://api.ote.domrobot.com/xmlrpc/

  • for the production environment https://api.domrobot.com/xmlrpc/

For more information about XML-RPC, visit the web site at http://www.xmlrpc.com/.

Example of a XML-RPC request:

<?xml version="1.0" encoding="UTF-8"?>    
        <methodCall>
          <methodName>account.login</methodName>
            <params>
              <param>
                <value>
                  <struct>
                    <member>
                      <name>user</name>
                        <value>
                          <string>your_username</string>
                        </value>
                    </member>
                    <member>
                      <name>pass</name>
                        <value>
                          <string>your_password</string>
                        </value>
                    </member>
                    <member>
                     <name>lang</name>
                      <value>
                        <string>en</string>
                      </value>
                    </member>
                    <member>
                      <name>clTRID</name>
                        <value>
                          <string>CLIENT-123123</string>
                        lt;/value>
                    </member>
                  </struct>
                </value>
              </param>
             </params>          
        </methodCall>          
          

Main (optional) parameters

  • lang: Language of the return message ('en' or 'de')

  • clTRID: The clTRID stands for Client Transaction Identifier and may be helpful for your support team

Method parameters

Are described in Chapter 2: Methods.