Описание API — различия между версиями
м |
|||
| Строка 1: | Строка 1: | ||
С WebHMI можно взаимодействовать с помощью [https://ru.wikipedia.org/wiki/REST REST]-подобного программного интерфейса (API). | С WebHMI можно взаимодействовать с помощью [https://ru.wikipedia.org/wiki/REST REST]-подобного программного интерфейса (API). | ||
| − | API предоставляет доступ ко всем основным функциям необходимым для сбора данных и управления системой. Вызов | + | API предоставляет доступ ко всем основным функциям необходимым для сбора данных и управления системой. Вызов метода API представляем собой HTTP-запрос с нужному URL с необходимыми параметрами. Доступны такие методы: |
* [//wiki.webhmi.com.ua/index.php/API_-_Список_соединений Список соединений]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_соединений Список соединений]; | ||
Версия 11:37, 18 января 2015
С 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 возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы.
