API - Список изображений/en — различия между версиями

Материал из WebHMI Wiki
Перейти к: навигация, поиск
(Новая страница: «Headers: <pre> Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7…»)
(Новая страница: «Response example: <pre> [ { "id": "1", "title": "Фон" }, { "id": "2", "title": "Пламя" } ] </pre> ----»)
Строка 30: Строка 30:
 
</pre>
 
</pre>
  
Пример ответа:
+
Response example:
 
<pre>
 
<pre>
 
[
 
[

Версия 09:17, 16 апреля 2018

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

To get a list of all images, you must perform a GET request on the URL like this: http://192.168.1.1/api/images.

To obtain information about a particular image, you must perform a GET request on a URL like this: 'http://192.168.1.1/api/images/1' . Here "1" is the ID of the desired connection.

In the headers, it is necessary to pass API key. For example:

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported.

Accept: application/json
Content-Type: application/json


Example of query for all images:

URL: http://192.168.1.1/api/images
Method: GET

Headers:

Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate, sdch
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Response example:

[
  {
    "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": "Пламя"
}


Атрибуты изображения:

idintУникальный идентификатор изображения
titlestringНазвание изображения