Difference between revisions of "Translations:API/1/ru"
(Created page with "API works through HTTP GET request, so you can work with your Larnitech server from browser, just sending requests from address string. Request: <syntaxhighlight lang="xml" li...") |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | API | + | API работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки. |
− | + | Запрос: | |
<syntaxhighlight lang="xml" line> | <syntaxhighlight lang="xml" line> | ||
http://IPADDR:PORT/JSON_REQUEST | http://IPADDR:PORT/JSON_REQUEST | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | + | Где: | |
− | IPADDR – | + | IPADDR – IP адрес вашего модуля METAFORSA или DE-MG; |
− | PORT – | + | PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure)). |
− | JSON_REQUEST – | + | JSON_REQUEST – запрос к серверу в формате json. |
− | + | Поля запроса JSON_REQUEST: | |
<ul> | <ul> | ||
− | <li>"requestType" - | + | <li>"requestType" - тип запроса: |
<ul> | <ul> | ||
− | <li>“getDevicesList” – | + | <li>“getDevicesList” – запрос на получение списка всех устройств;</li> |
− | <li>“getDeviceStatus” – | + | <li>“getDeviceStatus” – запрос на получение статуса устройства;</li> |
− | <li>“setDeviceStatus” – | + | <li>“setDeviceStatus” – запрос на установку статуса устройства;</li> |
− | <li>“setDeviceStatusRaw” – | + | <li>“setDeviceStatusRaw” – запрос на установку статуса устройства (статус в шестнадцатеричном формате);</li> |
− | <li>“getAllDevicesStatus” – | + | <li>“getAllDevicesStatus” – запрос на получение статуса всех устройств.</li> |
</ul> | </ul> | ||
</li> | </li> | ||
− | <li>“key” – | + | <li>“key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure)).</li> |
− | <li>“addr” – | + | <li>“addr” – адрес устройства.</li> |
− | <li>“status” – | + | <li>“status” – статус устройства.</li> |
</ul> | </ul> | ||
− | + | Примеры запросов и ответов: |
Latest revision as of 14:37, 16 January 2022
API работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки. Запрос:
1http://IPADDR:PORT/JSON_REQUEST
Где: IPADDR – IP адрес вашего модуля METAFORSA или DE-MG; PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure)). JSON_REQUEST – запрос к серверу в формате json. Поля запроса JSON_REQUEST:
- "requestType" - тип запроса:
- “getDevicesList” – запрос на получение списка всех устройств;
- “getDeviceStatus” – запрос на получение статуса устройства;
- “setDeviceStatus” – запрос на установку статуса устройства;
- “setDeviceStatusRaw” – запрос на установку статуса устройства (статус в шестнадцатеричном формате);
- “getAllDevicesStatus” – запрос на получение статуса всех устройств.
- “key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure)).
- “addr” – адрес устройства.
- “status” – статус устройства.
Примеры запросов и ответов: