API

Заголовки запроса (HEADERS)

Content-Type: application/json
Authorization: Token <token>

 

Брокер

GET https://dash.wqtt.ru/api/broker - Информация для подключения к брокеру

Ответ 200
{ 
    "server": "mX.wqtt.ru",
    "port: 1234,
    "port_tls": 1235,
    "websocket": 1237,
    "user": "user-name",
    "password": "123456"
}

 

POST https://dash.wqtt.ru/api/broker/messages/pub - Публикация сообщений

Запрос
[
    {"topic": "home/lamp1", "payload": "ON", "retain": false},
    {"topic": "home/lamp2", "payload": "OFF"}
]

Ответ 200
{"result": "ok"}

 

Устройства

GET https://dash.wqtt.ru/api/devices - Список всех устройств

Ответ 200
{
  "result": "ok",
  "devices": [
    {
      "id": 20390,
      "type": 0,
      "name": "Название устройства",
      "room": "Комната"
    },
    {
      "id": 21538,
      "type": 19,
      "name": "Кнопка"
    },
    {
      "id": 21335,
      "type": 19,
      "name": "Датчик",
      "room": "Комната"
    }
  ]
}

 

GET https://dash.wqtt.ru/api/devices/20390 - Подробное описание устройства по id

Ответ 200
{
  "result": "ok",
  "device": {
    "id": 20390,
    "name": "Название устройства",
    "type": 0,
    "retain_flag": false,
    "wait_execute": true,
    "room": "Комната",
    "on_off": [
      {
        "topic_cmd": "topic/power",
        "topic_state": "",
        "cmd_on": "ON",
        "cmd_off": "OFF"
      }
    ],
    "range": [
      {
        "type": 0,
        "topic_cmd": "topic/brig",
        "topic_state": "",
        "max": 100,
        "min": 0,
        "precision": 10,
        "multiplier": 1
      }
    ],
    "color": [
      {
        "type": 0,
        "topic_cmd": "topic/color",
        "topic_state": ""
      }
    ]
  }
}

 

POST https://dash.wqtt.ru/api/devices - Добавляет новое устройство

Запрос
{
      "name": "Название устройства",
      "type": 2,
      "room": "Комната",
      "on_off": [
        {
          "topic_cmd": "topic",
          "cmd_on": "1",
          "cmd_off": "0"
        }
      ]
}

Ответ 200
{
  "result": "ok",
  "detail": {
    "device_id": 23502
  }
}

 

DELETE https://dash.wqtt.ru/api/devices/23502 - Удаляет устройство по id

Ответ 200
{
  "result": "ok",
  "detail": "deleted"
}

 

GET https://dash.wqtt.ru/api/devices/types - Все возможные типы устройств, органов управления и датчиков

Ответ 200
{
  "types": {
    "device": [...],
    "range": [...],
    "color": [...],
    "mode": [...],
    "toggle": [...],
    "sensor_float": [...],
    "sensor_event": [...]
  }
}

 

GET https://dash.wqtt.ru/api/devices/refresh - Оповещает брокер и Яндекс об изменении конфигурации устройств

Ответ 200
{
  "result": "ok",
  "yandex_status_code": 202
}