Введение
В этой документации содержится информация, необходимая для разработки собственных приложений на базе Wialon.
Для запросов используется только метод POST. Дополнительные параметры (params) отправляются и возвращаются в виде JSON. Для всех текстовых параметров должна использоваться кодировка UTF-8.
Рекомендуется использовать формат DEC, поскольку HEX поддерживается только как текстовый формат.
Для Wialon Hosting в запросах используется host http://hst-api.wialon.com/ (http://hst-api.wialon.us/, http://hst-api.wialon.ru/ — в зависимости от датацентра), для Wialon Local — URL сайта мониторинга.
Шаблон запроса
Шаблон любого запроса должен выглядеть так:
http://{host}/wialon/ajax.html?sid=<text>&svc=<svc>¶ms={<params>}
В заголовке запроса необходимо указывать Content-Type:application/x-www-form-urlencoded.
Параметры
В запросе должны использоваться следующие параметры:
| Название | Описание |
|---|---|
| sid | Уникальный идентификатор сессии. |
| svc | Название запроса. |
| params | Параметры для выполнения запроса. |
В следующих разделах описаны значения только двух параметров: svc и params.
При выполнении всех запросов идентификатор сессии (sid) является обязательным параметром. Исключение составляют запросы из раздела Логин под токеном и некоторые запросов из раздела Другие запросы.
Длительность сессии по умолчанию при отсутствии выполняющихся запросов — 5 минут. Для поддержания сессии следует использовать постоянную отправку запроса avl_evts, например, раз в 2 секунды.
Все числа должны быть представлены в десятичной системе, в т. ч. флаги.