Before you call any function, the software must first authenticate itself. Read Authentication (Section 1.4) for more details. Once you authenticate, you are ready to use the API.
To call a function, you should specify at least the following parameters:
The name of the function
The authentication token that you received on authentication
One of xml or json, default is xml. This specifies format in which data will be sent and received.
In addition, you should specify the parameters required by the
function you are calling. See the function
reference for more details. On success, the X-Success
HTTP header has the value 1 while in case of failure it has the value 0.
An error message is present in the X-Error-Message header.
![]() | Important |
|---|---|
All parameter names and values are case sensitive. Token, TOKEN and token are treated differently. |