Difference between revisions of "Translations:API/1/ru"

From Larnitech wiki page
Jump to navigation Jump to search
(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...")
 
Line 1: Line 1:
−
API works through HTTP GET request, so you can work with your Larnitech server from browser, just sending requests from address string.
+
API работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки.
−
Request:
+
Запрос:
 
<syntaxhighlight lang="xml" line>
 
<syntaxhighlight lang="xml" line>
 
http://IPADDR:PORT/JSON_REQUEST
 
http://IPADDR:PORT/JSON_REQUEST
 
</syntaxhighlight>
 
</syntaxhighlight>
 
Where:
 
Where:
−
IPADDR – ip address of your metaforsa or DE-MG;
+
IPADDR – IP адрес вашего модуля METAFORSA или DE-MG;
−
PORT – port for API plugin (you can get it from LT Setup=&gt;Plugins=&gt;API=&gt;Configure button);
+
PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).
−
JSON_REQUEST – request to server in json format.
+
JSON_REQUEST – запрос к серверу в формате json.
−
Fields of JSON_REQUEST:
+
Поля запроса JSON_REQUEST:
 
<ul>
 
<ul>
−
  <li>"requestType" - Type of request:
+
  <li>"requestType" - тип запроса:
 
<ul>
 
<ul>
−
  <li>“getDevicesList” – request for getting the list of all devices;</li>
+
  <li>“getDevicesList” – запрос на получение списка всех устройств;</li>
−
  <li>“getDeviceStatus” – request for getting device status;</li>
+
  <li>“getDeviceStatus” – запрос на получение статуса устройства;</li>
−
  <li>“setDeviceStatus” – request for setting device status;</li>
+
  <li>“setDeviceStatus” – запрос на установку статуса устройства;</li>
−
         <li>“setDeviceStatusRaw” – request for setting device status (status in hex format);</li>
+
         <li>“setDeviceStatusRaw” – запрос на установку статуса устройства (статус в шестнадцатеричном формате);</li>
−
  <li>“getAllDevicesStatus” – request for getting all devices status.</li>
+
  <li>“getAllDevicesStatus” – запрос на получение статуса всех устройств.</li>
 
        
 
        
 
</ul>
 
</ul>
 
</li>
 
</li>
−
  <li>“key” – key for API plugin (you can get it from LT Setup=&gt;Plugins=&gt;API=&gt;Configure button).</li>
+
  <li>“key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).</li>
−
  <li>“addr” – address of device.</li>
+
  <li>“addr” – адрес устройства.</li>
−
  <li>“status” – status of device.</li>
+
  <li>“status” – статус устройства.</li>
 
</ul>
 
</ul>
−
Examples of requests and responses:
+
Примеры запросов и ответов:

Revision as of 14:34, 16 January 2022

Information about message (contribute)
This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.
Message definition (API)
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" line>
http://IPADDR:PORT/JSON_REQUEST
</syntaxhighlight>
Where:
IPADDR – ip address of your metaforsa or DE-MG;
PORT – port for API plugin (you can get it from LT Setup=&gt;Plugins=&gt;API=&gt;Configure button);
JSON_REQUEST – request to server in json format.
Fields of JSON_REQUEST:
<ul>
  <li>"requestType" - Type of request:
<ul>
  <li>“getDevicesList” – request for getting the list of all devices;</li>
  <li>“getDeviceStatus” – request for getting device status;</li>
  <li>“setDeviceStatus” – request for setting device status;</li>
       <li>“setDeviceStatusRaw” – request for setting device status (status in hex format);</li>
  <li>“getAllDevicesStatus” – request for getting all devices status.</li>
      
</ul>
</li>
  <li>“key” – key for API plugin (you can get it from LT Setup=&gt;Plugins=&gt;API=&gt;Configure button).</li>
  <li>“addr” – address of device.</li>
  <li>“status” – status of device.</li>
</ul>
Examples of requests and responses:
TranslationAPI работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки.
Запрос:
<syntaxhighlight lang="xml" line>
http://IPADDR:PORT/JSON_REQUEST
</syntaxhighlight>
Where:
IPADDR – IP адрес вашего модуля METAFORSA или DE-MG;
PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).
JSON_REQUEST – запрос к серверу в формате json.
Поля запроса JSON_REQUEST:
<ul>
  <li>"requestType" - тип запроса:
<ul>
  <li>“getDevicesList” – запрос на получение списка всех устройств;</li>
  <li>“getDeviceStatus” – запрос на получение статуса устройства;</li>
  <li>“setDeviceStatus” – запрос на установку статуса устройства;</li>
       <li>“setDeviceStatusRaw” – запрос на установку статуса устройства (статус в шестнадцатеричном формате);</li>
  <li>“getAllDevicesStatus” – запрос на получение статуса всех устройств.</li>
      
</ul>
</li>
  <li>“key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).</li>
  <li>“addr” – адрес устройства.</li>
  <li>“status” – статус устройства.</li>
</ul>
Примеры запросов и ответов:

API работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки. Запрос: 

1http://IPADDR:PORT/JSON_REQUEST

Where: 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” – статус устройства.

Примеры запросов и ответов:

Retrieved from "https://wiki.larnitech.com/index.php?title=Translations:API/1/ru&oldid=8111"