API - Запись нового значения в регистр — различия между версиями
Материал из WebHMI Wiki
(Новая страница: «Для записи нового значения в регистр необходимо выполнить PUT-запрос на URL вида '''http://192.168.1…») |
|||
Строка 14: | Строка 14: | ||
− | Пример | + | Пример записи значения 15 в регистр c ID = 5: |
− | '''URL''': http://192.168.1.1/api/register-values<br> | + | '''URL''': http://192.168.1.1/api/register-values/'''5'''<br> |
'''Method''': PUT | '''Method''': PUT | ||
Строка 26: | Строка 26: | ||
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7 | X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7 | ||
</pre> | </pre> | ||
+ | |||
+ | Тело запроса: | ||
+ | <pre> | ||
+ | {"value":"'''15'''"} | ||
+ | </pre> | ||
+ | |||
Если запрос валидный то API вернет HTTP-код 200. | Если запрос валидный то API вернет HTTP-код 200. |
Версия 07:41, 30 января 2015
Для записи нового значения в регистр необходимо выполнить 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
Пример записи значения 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.