Описание API/en — различия между версиями
(Новая страница: «The API provides access to all the basic functions necessary for data collection and system management. Calling the API method is an HTTP request to the сertain…») |
|||
| Строка 2: | Строка 2: | ||
With WebHMI, you can interact with [https://en.wikipedia.org/wiki/Representational_state_transfer REST]-like programming interface (API). | With WebHMI, you can interact with [https://en.wikipedia.org/wiki/Representational_state_transfer REST]-like programming interface (API). | ||
| − | API | + | The API provides access to all the basic functions necessary for data collection and system management. Calling the API method is an HTTP request to the сertain URL with the required parameters. The following methods are available: |
* [//wiki.webhmi.com.ua/index.php/API_-_Список_соединений Список соединений]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_соединений Список соединений]; | ||
Версия 15:37, 21 ноября 2017
With WebHMI, you can interact with REST-like programming interface (API).
The API provides access to all the basic functions necessary for data collection and system management. Calling the API method is an HTTP request to the сertain URL with the required parameters. The following methods are available:
- Список соединений;
- Список регистров;
- Получение лога регистров;
- Получение текущих значений регистров;
- Запись нового значения в регистр;
- Список словарей;
- Список трендов;
- Список графиков;
- Список изображений;
- Получение данных для графика;
- Список событий;
- Получение данных для события;
- Получение данных о локальном времени;
- Список панелей;
- Список блоков панелей;
Все данные возвращаются в формате JSON. Некоторые параметры необходимо передавать в виде части URL (обычно это ID события, регистра и т.д). Остальные параметры передаются в виде заголовков HTTP-запроса (временной интервал, API Key и другие). Более подробно смотрите в описании конкретного метода.
Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API (API Keys).
На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы.
