Описание 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…») |
(Новая страница: «All data is returned in the format [https://en.wikipedia.org/wiki/JSON JSON]. Some parameters must be passed as part of the URL (usually an event ID, register, et…») |
||
| Строка 20: | Строка 20: | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Список_блоков_панелей Список блоков панелей]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_блоков_панелей Список блоков панелей]; | ||
| − | + | All data is returned in the format [https://en.wikipedia.org/wiki/JSON JSON]. | |
| − | + | Some parameters must be passed as part of the URL (usually an event ID, register, etc.). The remaining parameters are passed in the form of HTTP request headers (time interval, API Key and others). For more details, see the description of the specific method. | |
Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API ([//wiki.webhmi.com.ua/index.php/API_Keys API Keys]). | Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API ([//wiki.webhmi.com.ua/index.php/API_Keys API Keys]). | ||
На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы. | На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы. | ||
Версия 15:40, 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:
- Список соединений;
- Список регистров;
- Получение лога регистров;
- Получение текущих значений регистров;
- Запись нового значения в регистр;
- Список словарей;
- Список трендов;
- Список графиков;
- Список изображений;
- Получение данных для графика;
- Список событий;
- Получение данных для события;
- Получение данных о локальном времени;
- Список панелей;
- Список блоков панелей;
All data is returned in the format JSON. Some parameters must be passed as part of the URL (usually an event ID, register, etc.). The remaining parameters are passed in the form of HTTP request headers (time interval, API Key and others). For more details, see the description of the specific method.
Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API (API Keys).
На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы.
