Visicom XML API

General provisions

Visicom XML API — simple protocol of message exchange with Visicom platform which uses XML for creation of messages. Coordination with the program is realized through HTTP-protocol according to POST method.

It is assumed to be a synchronous cooperation, i.e. each inquiry should have proper response, even if the inquiry is declined because of limitations and safety regulations.

For get authentication key (AUTHORITYKEY) you should send a letter to our email with the following information:

• your company name and contact name;
• site address (if in the design, then local address) and subject of site;
• contact numbers;

Interaction scheme

1. The sender creates a message represented as “valid” XML document. If the document contains symbols in Unicode, they shall be encoded in UTF-8.
2. The sender creates HTTP connection to Recipient’s URL address.
3. The sender sends HTTP POST inquiry containing generated XML document.
4. The receiver checks the “validity” of sender’s document then generates the response.
5. The receiver closes HTTP connection.

Example: MBR definition of group of objects

Inquiry

POST / HTTP/1.1
User-Agent: Java/1.6.0_06
Host: maps.visicom.ua/xmlapi/1.0.2
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-type: application/x-www-form-urlencoded
Content-Length: 325
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<request>
    <authority key="AUTHORITYKEY"/>
    <method name="getMBR"/>
    <parameters>
        <database>World_ru</database>
        <objects>
            <id>4151257218867881</id>
        </objects>
        <points>
            <point
             lat="50.4552"
             lng="30.5114"/>
        </points>
    </parameters>
</request>

Response

HTTP/1.1 200 OK
Server: Visicom-RequestServer/1.0
Date: 18 Jan 2009 16:42:21 GMT
Content-Type: text/xml; charset=utf-8
Content-Length: 153
Pragma: no-cache
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
    <rectangle
     max_lat="50.45520014"
     max_lng="30.51139989"
     min_lat="50.45520014"
     min_lng="30.51139989"/>
</response>