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>