You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 13
Next »
Программно HTTP API предоставляется модулем web2 (Веб-сервер 2.0).
HTTP API позволяет использовать следующие функции:
- Получение сведений об интерактивных картах: списка карт, имени карты, списка слоев карты, параметров слоя, фонового рисунка слоя, информации о списке точек и отдельной точке на слое (см. Карта).
- Получение сведений о классах объектов, созданных на Сервере, списка состояний для класса объектов и информации о состоянии, иконки для определенного состояния (см. Классы объектов).
- Получение списка объектов, созданных на сервере, информации об отдельном объекте, состояния объекта, списка доступных действий с объектом (см. Объекты).
- Получение событий с Сервера как отдельно, так и блоками (см. Получение событий).
- Отсылать команды на Сервер (см. Отсылка команд на сервер).
- Запускать выполнение макрокоманд (см. Макрокоманды).
- Работать с видео: получить кадры, запрашивать конфигурацию, получать живое видео и архив, управлять записью, ставить и снимать камеры с охраны, управлять телеметрией (см. Видео).
- Использовать системы нотификации для подписки приложения на сообщения APNS (см. Нотификация).
- Получать живой и архивный звук (см. Звук).
- Отправлять события и реакции в ядро ПК Интеллект (см. Отправка реакций и событий в ПК Интеллект по HTTP-запросу. Запрос кадра архива).
В примерах, приводимых в данном разделе, используются следующие обозначения:
- Port – порт. По умолчанию порт модуля Веб-сервер 2.0 — 8085. Указывать порт при отправке команд HTTP API обязательно.
- /web2 – веб-контекст, в котором работает модуль web2. Это контекст веб-приложения.
Далее описание будет опускаться там, где действие запроса понятно из контекста.
Формат ответа по умолчанию
По умолчанию формат ответа JSON. Включение ответа по умолчанию в формате XML осуществляется на панели настройки объекта Веб-сервер 2.0 (см. Настройка типа ответа на запросы HTTP API по умолчанию). Также формат ответа может быть явно указан в заголовке Accept, например application/json или application/xml. Указанный формат ответа в запросе имеет больший приоритет, чем заданный на панели настройки объекта Веб-сервер 2.0 формат ответа по умолчанию.
Кросс-доменные запросы (CORS)
В том случае, если к необходимым заголовкам доступа нет (например, в связи с политикой CORS браузера), то необходимо в заголовке запроса указать Origin (домен сайта, с которого происходит запрос). В таком случае в ответе будут содержаться заголовки Access-Control-Allow-Origin, который разрешают доступ к ресурсу с указанного домена кросс-сайтовым способом. Заголовок Access-Control-Allow-Origin: * означает, что к ресурсу можно получить доступ с любого домена кросс-сайтовым способом.