|
|
|
ANVEO API - REQUEST FORMAT
|
|
|
|
|
Anveo API supports 2 formats for API requests:
* XML based
* HTTP GET Query string
|
|
|
|
XML API Requests can be represented by the following structure:
|
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>YOURAPIUSERKEY1891e2e883904b0b894dc5b679c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="API_ACTION_NAME">
<PARAMETER NAME="SIGNATURE">396cdfaff3491f457b95e51a5ebd89ad516d623d</PARAMETER>
<PARAMETER NAME="TEST">TRUE</PARAMETER>
<PARAMETER NAME="PARAMETER_NAME_1">VALUE_1</PARAMETER>
<PARAMETER NAME="PARAMETER_NAME_2" ANOTHER_ATTRIBUTE="SOME_DATA" >VALUE_2</PARAMETER>
.....
<PARAMETER NAME="PARAMETER_NAME_N">PARAMETER_VALUE_N</PARAMETER>
</ACTION>
</REQUEST>
|
|
Details
USERKEY is your API USERKEY from the API Configuration screen.
ACTION XML node contains API Action details and NAME attribute holds the name of the API ACTION to be executed.
PARAMETER XML Node is used to pass parameters required by some API actions. 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 remember that XML is CASE SENSITIVE. All ANVEO API XML tags and attributes should be in upper case.
|
|
API XML Requests should be POSTed to https://www.anveo.com/api/v3.asp
To ensure proper data handling we recommend that you set the following HTTP headers:
Content-Type: application/xml; charset=UTF-8
Accept: application/xml; charset=UTF-8
|
|
HTTP GET API request uses QUERY STRING to pass API related details.
API parameters are passed as param[PARAMETERNAME]=PARAMETERVALUE query string attributes and call flow variables (when needed) are passed as var[VARIABLENAME]=VARIABLEVALUE
Multiple parameters and variables can be included using a usual '&' query string separator.
All HTTP Get requests are sent to https://www.anveo.com/api/v2.asp with information required for API request included in the query string.
For example:
|
|
https://www.anveo.com/api/v3.asp?userkey=YOURAPIKEY&action=DIAL.CONNECT¶m[SIGNATURE]=8046f1ffee1a63ca98bf14d4280c73a2bbd30625¶m[phonenumber]=12157010680¶m[destphonenumber]=123456789
|
|
Details
USERKEY is your API USERKEY from the API Configuration screen.
ACTION is the name of the API ACTION to be executed.
param[name]=value are used to pass parameters required by API actions. Each parameter has a name and a value.
|
|
|
|
SIGNATURE parameter is required for all API requests. SIGNATURE value which is calculated as HMAC_SHA1(YOUREMAILADDRESS,SECURE PHRASE) where YOUREMAILADDRESS is email address you use to access your Anveo account and SECURE PHRASE is Secure Phrase you've specified on API Configuration screen.
|
|
HMAC_SHA1 can be easily calculated in many programming languages and here is how it can be done in various languages:
PHP
hash_hmac('sha1', "some@email.com", "my secure phrase")
Ruby
digest = OpenSSL::Digest::Digest.new('sha1')
return OpenSSL::HMAC.hexdigest(digest, "some@email.com", "my secure phrase")
C#
var enc = Encoding.ASCII;
HMACSHA1 hmac = new HMACSHA1(enc.GetBytes("my secure phrase"));
hmac.Initialize();
byte[] buffer = enc.GetBytes("some@email.com");
return BitConverter.ToString(hmac.ComputeHash(buffer)).Replace("-", "").ToLower();
result for all above calculations shall be 396cdfaff3491f457b95e51a5ebd89ad516d623d
|
|
|
