Описание API — различия между версиями
Материал из WebHMI Wiki
(Отметить эту версию для перевода) |
|||
| (не показано 7 промежуточных версий 3 участников) | |||
| Строка 1: | Строка 1: | ||
| + | <languages/> | ||
| + | <translate> | ||
| + | <!--T:1--> | ||
С WebHMI можно взаимодействовать с помощью [https://ru.wikipedia.org/wiki/REST REST]-подобного программного интерфейса (API). | С WebHMI можно взаимодействовать с помощью [https://ru.wikipedia.org/wiki/REST REST]-подобного программного интерфейса (API). | ||
| − | API предоставляет доступ ко всем основным функциям необходимым для сбора данных и управления системой. Вызов | + | <!--T:2--> |
| + | API предоставляет доступ ко всем основным функциям необходимым для сбора данных и управления системой. Вызов метода API представляем собой HTTP-запрос с нужному URL с необходимыми параметрами. Доступны такие методы: | ||
| + | <!--T:3--> | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Список_соединений Список соединений]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_соединений Список соединений]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Список_регистров Список регистров]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_регистров Список регистров]; | ||
| Строка 9: | Строка 14: | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Запись_нового_значения_в_регистр Запись нового значения в регистр]; | * [//wiki.webhmi.com.ua/index.php/API_-_Запись_нового_значения_в_регистр Запись нового значения в регистр]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Список_словарей Список словарей]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_словарей Список словарей]; | ||
| + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_трендов Список трендов]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Список_графиков Список графиков]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_графиков Список графиков]; | ||
| + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_изображений Список изображений]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_графика Получение данных для графика]; | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_графика Получение данных для графика]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Список_событий Список событий]; | * [//wiki.webhmi.com.ua/index.php/API_-_Список_событий Список событий]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_события Получение данных для события]; | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_для_события Получение данных для события]; | ||
* [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_о_локальном_времени Получение данных о локальном времени]; | * [//wiki.webhmi.com.ua/index.php/API_-_Получение_данных_о_локальном_времени Получение данных о локальном времени]; | ||
| + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_панелей Список панелей]; | ||
| + | * [//wiki.webhmi.com.ua/index.php/API_-_Список_блоков_панелей Список блоков панелей]; | ||
| + | <!--T:4--> | ||
Все данные возвращаются в формате [https://ru.wikipedia.org/wiki/JSON JSON]. | Все данные возвращаются в формате [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
Некоторые параметры необходимо передавать в виде части URL (обычно это ID события, регистра и т.д). Остальные параметры передаются в виде заголовков HTTP-запроса (временной интервал, API Key и другие). Более подробно смотрите в описании конкретного метода. | Некоторые параметры необходимо передавать в виде части URL (обычно это ID события, регистра и т.д). Остальные параметры передаются в виде заголовков HTTP-запроса (временной интервал, API Key и другие). Более подробно смотрите в описании конкретного метода. | ||
| + | <!--T:5--> | ||
Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API ([//wiki.webhmi.com.ua/index.php/API_Keys API Keys]). | Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API ([//wiki.webhmi.com.ua/index.php/API_Keys API Keys]). | ||
| + | |||
| + | <!--T:6--> | ||
| + | На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы. | ||
| + | </translate> | ||
Текущая версия на 15:32, 21 ноября 2017
С WebHMI можно взаимодействовать с помощью REST-подобного программного интерфейса (API).
API предоставляет доступ ко всем основным функциям необходимым для сбора данных и управления системой. Вызов метода API представляем собой HTTP-запрос с нужному URL с необходимыми параметрами. Доступны такие методы:
- Список соединений;
- Список регистров;
- Получение лога регистров;
- Получение текущих значений регистров;
- Запись нового значения в регистр;
- Список словарей;
- Список трендов;
- Список графиков;
- Список изображений;
- Получение данных для графика;
- Список событий;
- Получение данных для события;
- Получение данных о локальном времени;
- Список панелей;
- Список блоков панелей;
Все данные возвращаются в формате JSON. Некоторые параметры необходимо передавать в виде части URL (обычно это ID события, регистра и т.д). Остальные параметры передаются в виде заголовков HTTP-запроса (временной интервал, API Key и другие). Более подробно смотрите в описании конкретного метода.
Для обеспечения безопасности и разограничения прав доступа используются ключи доступа API (API Keys).
На устройстве WebHMI есть песочница API. Она доступна по адресу вида http://192.168.1.1/api-docs/. Это мини-версия документации по API c возможностью выполнить любой запрос прямо из браузера и увидеть результат его работы.
