Описание API

Материал из WebHMI Wiki
Перейти к: навигация, поиск
Другие языки:
English • ‎русский

С WebHMI можно взаимодействовать с помощью REST-подобного программного интерфейса (API).

API предоставляет доступ ко всем основным функциям необходимым для сбора данных и управления системой. Вызов метода API представляем собой HTTP-запрос с нужному URL с необходимыми параметрами. Доступны такие методы:

Все данные возвращаются в формате JSON. Некоторые параметры необходимо передавать в виде части URL (обычно это ID события, регистра и т.д). Остальные параметры передаются в виде заголовков HTTP-запроса (временной интервал, API Key и другие). Более подробно смотрите в описании конкретного метода.

Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API (API Keys).

На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы.