Общие сведения о HTTP API

Программно HTTP API предоставляется модулем web2 (Веб-сервер 2.0).

HTTP API позволяет использовать следующие функции:

1. Получение сведений об интерактивных картах: списка карт, имени карты, списка слоев карты, параметров слоя, фонового рисунка слоя, информации о списке точек и отдельной точке на слое (см. Карта).
2. Получение сведений о классах объектов, созданных на Сервере, списка состояний для класса объектов и информации о состоянии, иконки для определенного состояния (см. Классы объектов).
3. Получение списка объектов, созданных на сервере, информации об отдельном объекте, состояния объекта, списка доступных действий с объектом (см. Объекты).
4. Получение событий с Сервера как отдельно, так и блоками (см. Получение событий).
5. Отсылать команды на Сервер (см. Отсылка команд на сервер).
6. Запускать выполнение макрокоманд (см. Макрокоманды).
7. Работать с видео: получить кадры, запрашивать конфигурацию, получать живое видео и архив, управлять записью, ставить и снимать камеры с охраны, управлять телеметрией (см. Видео).
8. Использовать системы нотификации для подписки приложения на сообщения APNS (см. Нотификация).
9. Получать живой и архивный звук (см. Звук).
10. Отправлять события и реакции в ядро ПК Интеллект (см. Отправка реакций и событий в ПК Интеллект по HTTP-запросу).

В примерах, приводимых в данном разделе, используются следующие обозначения:

• Port – порт. По умолчанию порт модуля Веб-сервер 2.0 — 8085. Указывать порт при отправке команд HTTP API обязательно.
• /web2 – веб-контекст, в котором работает модуль web2. Это контекст веб-приложения.

Далее описание будет опускаться там, где действие запроса понятно из контекста.

Авторизация

Для выполнения запросов необходима авторизация. Поддерживаются 2 типа авторизации: Basic и Bearer.

При авторизации Basic данные пользователя необходимо добавлять во все HTTP запросы в следующем виде:

http://[имя_пользователя]:[пароль]@[IP-адрес]:[порт]/web2

При авторизации Bearer используется токен, полученный от web-сервера (см. Авторизация в ПК Интеллект по token ключу).

Формат ответа по умолчанию

По умолчанию формат ответа JSON. Включение ответа по умолчанию в формате XML осуществляется на панели настройки объекта Веб-сервер 2.0 (см. Настройка типа ответа на запросы HTTP API по умолчанию). Также формат ответа может быть явно указан в заголовке Accept, например application/json или application/xml. Указанный формат ответа в запросе имеет больший приоритет, чем заданный на панели настройки объекта Веб-сервер 2.0 формат ответа по умолчанию.

Кросс-доменные запросы (CORS)

Для выполнения кросс-доменных запросов или для получения доступа к необходимым заголовкам в ответе (например, в связи с ограничениями из-за политики CORS браузера), необходимо в заголовке запроса указать Origin (домен сайта, с которого происходит запрос). В таком случае в ответе будет содержаться заголовок Access-Control-Allow-Origin, который указывает на разрешение доступа к ресурсу с указанного домена кросс-сайтовым способом. Заголовок Access-Control-Allow-Origin: * означает, что к ресурсу можно получить доступ с любого домена кросс-сайтовым способом.