Описание API/en — различия между версиями

Текущая версия на 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.