API - Список трендов — различия между версиями
Материал из WebHMI Wiki
(не показана одна промежуточная версия этого же участника) | |||
Строка 1: | Строка 1: | ||
+ | <languages/> | ||
<translate> | <translate> | ||
+ | <!--T:1--> | ||
Для получения списка всех трендов необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/trends'''. | Для получения списка всех трендов необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/trends'''. | ||
+ | <!--T:2--> | ||
Для получения информации о конкретном тренде необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/trends/1'''. Здесь 1 - это ID нужного тренда. | Для получения информации о конкретном тренде необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/trends/1'''. Здесь 1 - это ID нужного тренда. | ||
+ | <!--T:3--> | ||
В заголовках запроса необходимо передать API key. Например: | В заголовках запроса необходимо передать API key. Например: | ||
<pre> | <pre> | ||
Строка 9: | Строка 13: | ||
</pre> | </pre> | ||
+ | <!--T:4--> | ||
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
Строка 17: | Строка 22: | ||
+ | <!--T:5--> | ||
Пример запроса списка всех трендов: | Пример запроса списка всех трендов: | ||
+ | <!--T:6--> | ||
'''URL''': http://192.168.1.1/api/trends<br> | '''URL''': http://192.168.1.1/api/trends<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:7--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 30: | Строка 38: | ||
</pre> | </pre> | ||
+ | <!--T:8--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 54: | Строка 63: | ||
+ | <!--T:9--> | ||
Пример запроса информации о тренде номер 2: | Пример запроса информации о тренде номер 2: | ||
+ | <!--T:10--> | ||
'''URL''': http://192.168.1.1/api/trends/2<br> | '''URL''': http://192.168.1.1/api/trends/2<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:11--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 67: | Строка 79: | ||
</pre> | </pre> | ||
+ | <!--T:12--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 81: | Строка 94: | ||
+ | <!--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> |
Текущая версия на 07:47, 16 апреля 2018
Для получения списка всех трендов необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/trends.
Для получения информации о конкретном тренде необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/trends/1. Здесь 1 - это ID нужного тренда.
В заголовках запроса необходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка всех трендов:
URL: http://192.168.1.1/api/trends
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[ { "id": "1", "regsid": "16", "title": "Горелка", "height": "350", "min_val": "0", "max_val": "" }, { "id": "2", "regsid": "11,12,13", "title": "Токи A, B, C", "height": "350", "min_val": "0", "max_val": "1500" } ]
Пример запроса информации о тренде номер 2:
URL: http://192.168.1.1/api/trends/2
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{ "id": "2", "regsid": "11,12,13", "title": "Токи A, B, C", "height": "350", "min_val": "0", "max_val": "1500" }
Атрибуты тренда:
id | int | Уникальный идентификатор тренда |
title | string | Название тренда |
regsid | string | Список идентификаторов регистров которые необходимо отображать на тренде. Регистры разделены запятыми. |
height | int | Высота тренда в пикселях |
min_val | double | Минимальное значение оси Y |
max_val | double | Максимальное значение оси Y |