Описание API/en — различия между версиями
(Новая страница: «API Description») |
|||
(не показано 6 промежуточных версий 1 участника) | |||
Строка 1: | Строка 1: | ||
<languages/> | <languages/> | ||
− | + | 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_-_Список_соединений Connection list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_регистров | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_регистров Register list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_лога_регистров | + | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_лога_регистров Getting registers log]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_текущих_значений_регистров | + | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_текущих_значений_регистров Getting current register values]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Запись_нового_значения_в_регистр | + | * [//wiki.webhmi.com.ua/index.php/API_-_Запись_нового_значения_в_регистр Writing a new value into register]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_словарей | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_словарей Dictionary list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_трендов | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_трендов Trends list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_графиков | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_графиков Graph list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_изображений | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_изображений Image list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_графика | + | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_графика Getting graph data]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_событий | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_событий Event list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_события | + | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_события Getting event data]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_о_локальном_времени | + | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_о_локальном_времени Getting local time data]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_панелей | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_панелей Panel list]; |
− | * [//wiki.webhmi.com.ua/index.php/API_-_Список_блоков_панелей | + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_блоков_панелей List of panel blocks]; |
− | + | 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. | |
− | + | To ensure the security and delineation of access rights, the API access keys are used ([//wiki.webhmi.com.ua/index.php/API_Keys API Keys]). | |
− | + | The WebHMI device has an API sandbox. It is available at the address http://192.168.1.1/api-docs/. This is a mini version of the API documentation with the ability to execute any query directly from the browser and see the result of its work. |
Текущая версия на 11:40, 1 марта 2018
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:
- Connection list;
- Register list;
- Getting registers log;
- Getting current register values;
- Writing a new value into register;
- Dictionary list;
- Trends list;
- Graph list;
- Image list;
- Getting graph data;
- Event list;
- Getting event data;
- Getting local time data;
- Panel list;
- List of panel blocks;
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.
To ensure the security and delineation of access rights, the API access keys are used (API Keys).
The WebHMI device has an API sandbox. It is available at the address http://192.168.1.1/api-docs/. This is a mini version of the API documentation with the ability to execute any query directly from the browser and see the result of its work.