API - Список панелей — различия между версиями
Материал из WebHMI Wiki
(Отметить эту версию для перевода) |
|||
Строка 1: | Строка 1: | ||
<translate> | <translate> | ||
+ | <!--T:1--> | ||
Для получения списка всех панелей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dashboards'''. | Для получения списка всех панелей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dashboards'''. | ||
+ | <!--T:2--> | ||
Для получения информации о конкретной панели необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dashboards/12'''. Здесь 12 - это ID нужной панели. | Для получения информации о конкретной панели необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dashboards/12'''. Здесь 12 - это ID нужной панели. | ||
+ | <!--T:3--> | ||
В заголовках запроса ноебходимо передать API key. Например: | В заголовках запроса ноебходимо передать API key. Например: | ||
<pre> | <pre> | ||
Строка 9: | Строка 12: | ||
</pre> | </pre> | ||
+ | <!--T:4--> | ||
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
Строка 17: | Строка 21: | ||
+ | <!--T:5--> | ||
Пример запроса списка панелей: | Пример запроса списка панелей: | ||
+ | <!--T:6--> | ||
'''URL''': http://192.168.1.1/api/dashboards<br> | '''URL''': http://192.168.1.1/api/dashboards<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:7--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 30: | Строка 37: | ||
</pre> | </pre> | ||
+ | <!--T:8--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 52: | Строка 60: | ||
+ | <!--T:9--> | ||
Пример запроса информации об соединений номер 1: | Пример запроса информации об соединений номер 1: | ||
+ | <!--T:10--> | ||
'''URL''': http://192.168.1.1/api/dashboards/1<br> | '''URL''': http://192.168.1.1/api/dashboards/1<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:11--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 65: | Строка 76: | ||
</pre> | </pre> | ||
+ | <!--T:12--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 78: | Строка 90: | ||
+ | <!--T:13--> | ||
Атрибуты панелей: | Атрибуты панелей: | ||
+ | <!--T:14--> | ||
<table> | <table> | ||
<tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор панели</td></tr> | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор панели</td></tr> |
Версия 09:28, 18 апреля 2018
Для получения списка всех панелей необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/dashboards.
Для получения информации о конкретной панели необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/dashboards/12. Здесь 12 - это ID нужной панели.
В заголовках запроса ноебходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка панелей:
URL: http://192.168.1.1/api/dashboards
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[ { "id": "1", "title": "Упаковка", "hide_title": "0", "width": "900", "height": "450" }, { "id": "2", "title": "Расход воды", "hide_title": "1", "width": "1024", "height": "800" } ]
Пример запроса информации об соединений номер 1:
URL: http://192.168.1.1/api/dashboards/1
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{ "id": "1", "title": "Упаковка", "hide_title": "0", "width": "900", "height": "450" }
Атрибуты панелей:
id | int | Уникальный идентификатор панели |
title | string | Название панели |
hide_title | int | 0 = отображать название панели, 1 = спрятать название панели |
width | int | Ширина рабочей области панели в пикселях |
height | int | Высота рабочей области панели в пикселях |