API - Список изображений — различия между версиями
Материал из WebHMI Wiki
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
| + | <languages/> | ||
<translate> | <translate> | ||
| + | <!--T:1--> | ||
Для получения списка всех изображений необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/images'''. | Для получения списка всех изображений необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/images'''. | ||
| + | <!--T:2--> | ||
Для получения информации о конкретном изображении необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/images/1'''. Здесь 1 - это ID нужного изображения. | Для получения информации о конкретном изображении необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/images/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/images<br> | '''URL''': http://192.168.1.1/api/images<br> | ||
'''Method''': GET | '''Method''': GET | ||
| + | <!--T:7--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
| Строка 30: | Строка 38: | ||
</pre> | </pre> | ||
| + | <!--T:8--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
| Строка 46: | Строка 55: | ||
| + | <!--T:9--> | ||
Пример запроса информации о изображений номер 2: | Пример запроса информации о изображений номер 2: | ||
| + | <!--T:10--> | ||
'''URL''': http://192.168.1.1/api/images/2<br> | '''URL''': http://192.168.1.1/api/images/2<br> | ||
'''Method''': GET | '''Method''': GET | ||
| + | <!--T:11--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
| Строка 59: | Строка 71: | ||
</pre> | </pre> | ||
| + | <!--T:12--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
| Строка 69: | Строка 82: | ||
| + | <!--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:20, 16 апреля 2018
Для получения списка всех изображений необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/images.
Для получения информации о конкретном изображении необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/images/1. Здесь 1 - это ID нужного изображения.
В заголовках запроса необходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка всех изображений:
URL: http://192.168.1.1/api/images
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[
{
"id": "1",
"title": "Фон"
},
{
"id": "2",
"title": "Пламя"
}
]
Пример запроса информации о изображений номер 2:
URL: http://192.168.1.1/api/images/2
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{
"id": "2",
"title": "Пламя"
}
Атрибуты изображения:
| id | int | Уникальный идентификатор изображения |
| title | string | Название изображения |
