Visicom XML API

Общие положения

Visicom XML API — это простой протокол обмена сообщения с платформой Visicom, который использует XML для формирования сообщений. Всё взаимодействие с программой осуществляется посредством HTTP-протокола, методом POST.

Предполагается синхронная модель взаимодействия, т. е. на каждый запрос должен существовать ответ. Даже в случаях, когда запрос отклонен из-за имеющихся ограничений или соображений безопасности.

Для получения ключа аутентификации (AUTHORITYKEY) необходимо отправить письмо на наш email со следующей информацией:

• название вашей компании, имя контактного лица;
• адрес сайта (если в разработке, то локальный адрес) и его тематика;
• контактные телефоны;

Схема взаимодействия

1. Отправитель создает сообщение представленное как «валидный» XML документ. Если в документе содержатся символы в UNICODE то они должны быть закодированы в UTF-8.
2. Отправитель создает HTTP соединение к адресу URL получателя.
3. Отправитель отсылает HTTP POST запрос, в теле которого находится сгенерированный XML документ.
4. Получатель проверяет «валидность» документа отправителя и затем генерирует ответ.
5. Получатель закрывает HTTP соединение.

Пример: определение MBR группы объектов

Запрос

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>

Ответ

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>