API Xeoma для синхронизации со сторонними сервисами и программами

API (от англ. application programming interface — программный интерфейс приложения) — это набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) или операционной системой для использования во внешних программных продуктах.

Проще говоря, API — это набор средств для интеграции со сторонними сервисами, приложениями, системами.

Для всех, кто хочет интегрировать Xeoma со своими продуктами или просто внешними сервисами и системами, в Xeoma функцию API выполняют специализированные модули (HTTP Переключатель, Отправка HTTP-команд, Запуск приложения, GPIO (доступно только для Linux ARM), опции в Распознавателе автономеров и т.п.), Web API, JSON API и API Xeoma Pro Ваше Облако.

HTTP Переключатель

HTTP Переключатель — этот модуль принимает команды по сети (в основном, от различных систем автоматизации, СКУД и систем «умный дом») и позволяет включать/выключать последующие модули (все модули далее в цепочке после HTTP переключателя) при приеме http-запроса. Работает по принципу размыкателя/замыкателя цепи – при получении команды на выключение размыкает цепь, при получении команды на включение замыкает цепь.
Подробнее о модуле, его использовании и настройке

Отправка HTTP-команд

Отправка HTTP-команд — этот модуль позволяет формировать и отсылать HTTP-запросы, в том числе и в сторонние системы автоматизации (например, автоматическое поднятие шлагбаума при распознании автомобиля из «белого» списка). Модуль можно подключать после нужных детекторов, например, детектора движения или распознавателя лиц, чтобы отправлять команду в качестве реакции на сработку. В запрос также можно автоматически включать параметры.
Подробнее о модуле, его использовании и настройке

Запуск приложения

Запуск приложения — этот модуль позволяет запускать выбранное приложение (например, скрипт по обработке данных и отправке сообщения в skype). Так же, как и модуль «Отправка HTTP-команд», этот модуль может быть подключен после нужных фильтров-детекторов для сработки при наступлении определенного события (например, обнаружении движения), подключите его после детектора движения.
Поддерживает некоторые макросы и передачу пути к изображению.

GPIO (доступно только на Linux ARM)

«GPIO модуль» можно использовать для работы с GPIO пинами на устройствах Linux ARM, то есть для интеграции с различными внешними системами, такими как автоматизированные двери, смарт ТВ, система освещения, датчики температуры, кондиционеры и другими устройствами в доме. GPIO модуль в Xeoma позволит добавлять пины и назначить им определенное действие и включать/выключать его через Xeoma в 1 клик.

Подробнее — в статье про GPIO в Xeoma

Распознаватель номеров

Также в качестве API может выступать синхронизация с внешними базами данных или скриптами в модуле ANPR (Распознавателе автономеров) — опция «Путь/URL к внешнему модулю».
Например, http://192.168.1.1/vms.cgi?number={NUMBER}
где скрипту vms.cgi в качестве параметра будет передаваться number со значением {NUMBER}

А для интеграции с кассовыми аппаратами используйте модуль «HTTP Маркировка».

Web API

С помощью Web API вы можете получать живое видео, кадр из реального времени или из архива за определенное время, экспортировать отрезок из архива, добавить новую камеру или FTP приемник.
Это можно использовать для встраивания на сайт (например, в качестве информера о погоде или пробках на дорогах) или в системах автоматизации.
Внимание: в цепочках должен быть модуль «Веб Сервер».
Подробнее о доступных командах

JSON API

Если нужно больше, чем позволяет Web API (см. выше), в Xeoma есть профессиональный API для интеграции в сторонние системы — JSON API.
Этот API позволяет провести множество действий извне:
получить список используемых на данный момент на сервере модулей,
узнать их имена на языке программы,
включить или выключить модули или узнать и изменить их настройки,
выполнить поиск камер с определёнными параметрами,
узнать статус записи и произвести поиск каких-то объектов,
экспортировать записи,
выяснить время сервера, и многое другое.
Внимание: требуется как минимум 1 лицензия Xeoma Pro.
Подробнее о доступных командах

API Xeoma Pro Ваше Облако

Помимо возможности создания собственных скриптов для управления конфигурационными файлами режима Xeoma Pro Ваше Облако, поддерживается также REST API для управления скриптами, создающимися по умолчанию.

Синтаксис:
xeoma_cloud.php -a «username» «useremail» «password» days months sources storageGB storageDays clients bandwidthMbits «listOfDisabledModules» «templatePath»

Тестовый пример:
xeoma_cloud.php -a «User Name» «myEmail@email» «123456» 0 2 3 4 5 6 7 «FileInput, FileOutput» ‘/home/a/Desktop/33/cloud_config_template.dat’

Расшифровка:
На скрипт xeoma_cloud.php посылается команда для создания нового пользователя (-а) с именем пользователя User Name, адресом электронной почты myEmail@email и паролем 123456 сроком подписки на 2 месяца (цифры 0 для дней и 2 для месяцев), при этом пользователю будут доступны 3 камеры (цифра 3), объем диска 4 GB (цифра 4), хранение записей до включения перезаписи 5 дней, до 6 одновременных подключений (цифра 6), но будут недоступны модули Сохранение в Файл и Чтение из Файла (перечислены запрещенные модули FileInput, FileOutput). Цепочка по умолчанию будет применена из примера настроек cloud_config_template.dat, который в примере находится по пути /home/a/Desktop/33/ .

Также для Xeoma Pro Ваше Облако есть API интеграции с биллингом — подробнее см. в Xeoma Pro Ваше Облако. Инструкция по применению

Остались вопросы? Мы с радостью на них ответим. Свяжитесь с нами

16 февраля 2018