|
|
|
API CALL REQUEST - XML Format.
|
| |
|
|
Anveo API REQUESTs are XML based messages sent over HTTPS to Anveo.com.
In general API Request XML Messages can be represented by the following structure:
|
|
XML
_________
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>YOURAPIUSERKEY1891e2e883904b0b894dc5b679c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="API_ACTION_NAME">
<PARAMETER NAME="TEST">TRUE</PARAMETER>
<PARAMETER NAME="PARAMETER_NAME_1">PARAMETER_VALUE_1</PARAMETER>
<PARAMETER NAME="PARAMETER_NAME_2" ANOTHER_ATTRIBUTE="SOME_DATA" >PARAMETER_VALUE_2</PARAMETER>
.....
<PARAMETER NAME="PARAMETER_NAME_N">PARAMETER_VALUE_N</PARAMETER>
</ACTION>
</REQUEST>
|
|
|
Explanation
USERKEY is your API USERKEY from the API Configuration screen.
ACTION node contains API Action details.
NAME attribute holds the name of the API ACTION to be executed.
Depending on the ANVEO API ACTION you may provide various parameters. Parameters are represented by separate PARAMETER XML tags. Each parameter has a name and a value plus some additional attributes. In this example, the parameter named TEST has a value of TRUE, indicating that this is a test action.
Please review various API Actions for details and sample XML Messages.
|
|
|
Please remember that XML is CASE SENSITIVE. All ANVEO API XML tags and attributes should be in upper case.
|
|
|
When posting API XML Requests to https://www.anveo.com/apicall.asp we recommend that you setup some HTTP headers to ensure proper data handling as following:
|
|
Content-Type: application/xml; charset=UTF-8
Accept: application/xml; charset=UTF-8
|
|
|
|
