API - Запись нового значения в регистр — различия между версиями
Материал из WebHMI Wiki
(Отметить эту версию для перевода) |
|||
| (не показаны 3 промежуточные версии 2 участников) | |||
| Строка 1: | Строка 1: | ||
| − | Для записи нового значения в регистр необходимо выполнить PUT-запрос на URL вида '''http://192.168.1.1/api/register-values/23'''. Здесь 23 - это ID регистра для которого | + | <translate> |
| + | <!--T:1--> | ||
| + | Для записи нового значения в регистр необходимо выполнить PUT-запрос на URL вида '''http://192.168.1.1/api/register-values/23'''. Здесь 23 - это ID регистра для которого необходимо изменить значение. | ||
| + | <!--T:2--> | ||
В заголовках запроса необходимо передать API key. Например: | В заголовках запроса необходимо передать API key. Например: | ||
<pre> | <pre> | ||
| Строка 6: | Строка 9: | ||
</pre> | </pre> | ||
| + | <!--T:3--> | ||
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
| Строка 12: | Строка 16: | ||
</pre> | </pre> | ||
| + | <!--T:4--> | ||
В теле запроса необходимо передать json-объект с единственным свойством "value":<br> | В теле запроса необходимо передать json-объект с единственным свойством "value":<br> | ||
<pre> | <pre> | ||
| Строка 17: | Строка 22: | ||
</pre> | </pre> | ||
| + | <!--T:5--> | ||
---- | ---- | ||
| + | <!--T:6--> | ||
Пример записи значения 15 в регистр c ID = 5: | Пример записи значения 15 в регистр c ID = 5: | ||
| − | '''URL''': http://192.168.1.1/api/register-values/ | + | <!--T:7--> |
| + | '''URL''': http://192.168.1.1/api/register-values/5<br> | ||
'''Method''': PUT | '''Method''': PUT | ||
| + | <!--T:8--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
| Строка 33: | Строка 42: | ||
</pre> | </pre> | ||
| + | <!--T:9--> | ||
Тело запроса: | Тело запроса: | ||
<pre> | <pre> | ||
| Строка 38: | Строка 48: | ||
</pre> | </pre> | ||
| − | + | <!--T:10--> | |
| − | + | ||
Если запрос валидный то API вернет HTTP-код 200. | Если запрос валидный то API вернет HTTP-код 200. | ||
| + | </translate> | ||
Текущая версия на 10:41, 13 апреля 2018
Для записи нового значения в регистр необходимо выполнить PUT-запрос на URL вида http://192.168.1.1/api/register-values/23. Здесь 23 - это ID регистра для которого необходимо изменить значение.
В заголовках запроса необходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
В теле запроса необходимо передать json-объект с единственным свойством "value":
{"value":"12"}
Пример записи значения 15 в регистр c ID = 5:
URL: http://192.168.1.1/api/register-values/5
Method: PUT
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Тело запроса:
{"value":"15"}
Если запрос валидный то API вернет HTTP-код 200.
