API

После запуска, IPNoise начинает слушать TCPv4 порт 2210, в ожидании клиентов. Будут поддерживаться разные типы связи с клиентами:

1. text-telnet Данный режим используется для тестирования, а также для ручного доступа к IPNoise. Позволяет подключаться посредством telnet и выполнять различные команды. После подключения telnet'ом нужно отправить перевод строки
2. http Данный режим позволяет отправлять API команды под видом HTTP/1.1 запросов, полезно для web-based клиентов
3. raw Прямая отправка IPNoise API команд

Всё API общение делится на два типа:

1. Команды (Commands)
2. События (Events)

Запрос и ответ могут содержать как команды, так и события.

Все команды и события содержат атрибут “ver” - версия. Он необходим для поддержки совместимости по мере развития. Пожалуйста не забывайте про версии, если команда/событие ведут себя не так, как Вы ожидаете, в первую очередь проверьте версию.

Пример команды:

<ipnoise ver="0.01" sessid="00112233445566778899aabbccdd0011223344">
    <commands>    
        <command type="searchRoute" ver="0.01" id="c2892289b1cded01c609a502262a1bbebebd9bbb"/>
    </commands>
</ipnoise>

Пример события:

<ipnoise ver="0.01"sessid="00112233445566778899aabbccdd0011223344">
    <events>
        <event type="searchRouteAnswer" ver="0.01" id="c2892289b1cded01c609a502262a1bbebebd9bbb"/>
    </events>
</ipnoise>