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

Материал из WebHMI Wiki
Перейти к: навигация, поиск
(Новая страница: «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 abilit…»)
Строка 25: Строка 25:
 
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]).
 
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]).
  
На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы.
+
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.

Версия 15:45, 21 ноября 2017

Другие языки:
English • ‎русский

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.

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.