Текущая версия на 17:12, 30 июля 2019

Другие языки:

English • ‎русский • ‎українська • ‎中文（中国大陆）‎

API v01 *

API ( json )

Содержание

1 Общие сведения
2 Учётная запись
3 Контроллеры
4 Устройства
5 Wizard добавления устройств
6 Сценарии
7 Логи пользователя (logs)
8 Коды
9 События
- 9.1 Нажатие кнопки на устройстве (event)
10 Места
11 Виджеты
12 Неклассифицируемые методы
- 12.1 Список доступных стран (countries)
13 Ошибки

Общие сведения

Обмен данными между Пользователем и серверной частью системы Quadrobit Smart Home осуществляется путём отправки пакетов (запросов и ответов). Пакет отправляется по HTTP методом POST на указанный адрес Request URL.

Запрос может содержать JSON-структуру, включающую один или несколько параметров. После успешной авторизации Пользователя запрос всегда должен содержать параметр token.

В ответ на полученный запрос Сервер возвращает Пользователю следующую JSON-структуру:

{
	error: null,
	data: { ... }	
}

Параметр error содержит информацию о результате выполнения запроса. error: null - запрос выполнен успешно.

Структура и содержание параметра data определяется типом запроса.

Учётная запись

Авторизация (login)

Запрос:

Request URL: [site]/api/login

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

(string) email,
(string) password

Пример запроса:

{
	"email":"aaaa@aaaa.aa",
	"password":"12345678"
}

Ответ:

Пример ответа (data):

{
	"user_id":1,
	"username":"Ivan Pupkin",
	"email":"aaaa@aaa.aa",
	"phone": "423546546546",
	"sex":2, 		// пол 0 - не указан , 1 - женский  , 2 - мужской
	"country":219,  		// код страны в базе
	"active_configuration":"1",
	"refcode":"JHE-1GD-T8B-9HB",
	"status":10,       		// 0 - неактивен , 10 - активен
	"token":"1Cyuvr9DKMbB6aFQ-mLPLeGZXFLyuK8d",
	"expired":1502586831 // метка времени до которой активен token
}

Регистрация (registration)

Запрос:

Request URL: [site]/api/registration

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

(string) email,
(string) password

Пример запроса:

{
	"email":"aaaa@aaaa.aa",
	"password":"12345678"
}

Ответ:

Пример ответа (data):

{
    	"user_id": 43,
    	"username": "user_4383",
    	"email": "aaaa@aaa.aa",
    	"sex": null,
   	 "country": null,
   	 "active_configuration": null,
    	"refcode": "746-81O-0RJ-RJS",
    	"status": 10
}

Профиль пользователя (profile)

Запрос:

Request URL: [site]/api/profile/

Параметры запроса: (string) token

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"user_id":1,
	"username":"Ivan Pupkin",
	"email":"aaaa@aaa.aa",
	"phone": "423546546546",
	"sex":2, 		// пол 0 - не указан , 1 - женский  , 2 - мужской
	"send_email": 1,
              "send_sms": 0,
               "role": 1,
               "lang": 2,
	"country":219,  		// код страны в базе
	"active_configuration":"1",
	"refcode":"JHE-1GD-T8B-9HB",
	"status":10,       		// 0 - неактивен , 10 - активен
	"token":"1Cyuvr9DKMbB6aFQ-mLPLeGZXFLyuK8d",
}

Контроллеры

Список Контроллеров Пользователя (list)

Запрос:

Request URL: [site]/api/ctrl/list/

Параметры запроса: (string) token

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
"0":{
	"id": 651,
	"name": "AE439648F951",
	"ip": "192.168.10.135",
	"fw_id": "1",
	"hostname": "quadrobase",
	"armed": 0,
	"address": "",
	"lat": null,
	"lng": null,
	"timezone": 2,
	"online": 1,
	"last_online": "2019-06-17 19:36:48",
	"type_signal": "wifi",
	"wifi_param": -67,
	"gsm_param": 0,
	"phone": "",
	"pin": 0,
	"user_controller_name": "quadrobase",
	"on_dashboard": 0
}]

Информация о Контроллере (info)

Запрос:

Request URL: [site]/api/ctrl/info/

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 1 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"id":"6",
	"name":"66D4E809EF0A",
	"hostname":"Test Valera 34",
	"armed":0,
	"address":"",
	"lat":50.4156,
	"lng":30.5336,
	"ip":"192.168.1.155",
	"fw_id":1,
	"timezone":3,
	"online":1,
	"last_online":"2019-07-29 17:08:41",
	"type_signal":"wifi",
	"wifi_param":-78,
	"gsm_param":0,
	"phone":"",
	"pin":0,
	"user_controller_name":"Test Valera 34",
	"on_dashboard":0
}

Постановка/снятие Контроллера на охрану / с охраны (armed)

Запрос:

Request URL: [site]/api/ctrl/armed/

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

№(int) controller_id, №(string) token

Пример запроса:

{
	"controller_id": 6 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Так как MQTT односторонний - ответа быть не может. Ответ что запрос ушел:

Ответ:

Пример ответа (data):

{
	"result": "Ok"
}

Добавление Контроллера (add)

Запрос:

Request URL: [site]/api/ctrl/add

Параметры запроса: (string) token

Пример:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа:

{
	"PIN":"7gDH"
}

После ввода пин-кода необходимо обновить список Контроллеров (/api/ctrl/list/)

Обновление списка устройств и действий на Контроллере (update)

Этап 1 - обновляем список IDS устройств на Контроллере

Запрос:

Request URL: [site]/api/ctrl/update/

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 6 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"result": "Ok" // "Ok" = запрос отправлен
}

Этап 2 - обновляем информацию о каждом устройстве

Запрос:

Request URL: [site]/api/ctrl/update-devices/

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 6 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
}

Ответ:

Пример ответа:

{
	"result": "Ok" // Запрос отправлен
}

Процесс происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (контроллер, устройства)

Удаление Контроллера (delete)

Запрос:

Request URL: [site]/api/ctrl/delete

Пример запроса:

{
	"token":"8yE-VIQrYuZ2bTeho_lajxjOJPnIe_Yx",
	"controller_id":"81"	
}

Ответ:

Пример ответа:

{
	"error":null,
	"data":{"result":"Ok"}
}

Обновление статуса контроллера (update-status)

Запрос:

Request URL: [site]/api/ctrl/update-status/

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

(string) token,
(int) controller_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"controller_id": 122
}

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"result":"Ok"
		}
}

Получение актуального статуса Контроллера (get-status)

Запрос:

Request URL: [site]/api/ctrl/get-status/

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

(string) token,
(int) controller_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"controller_id": 122
}

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"status":1
		}
}

Поле “status” может принимать следующие значения: • 0 – офлайн

• 1 – онлайн

• 2 – онлайн, после включения питания

Получение конфигурации Контроллера (config)

Запрос:

Request URL: [site]/api/ctrl/config/

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

(string) token,
(int) controller_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"controller_id" : 111
}

Ответ:

Пример ответа (data):

{
	"id":"1",   // id конфигурации
	"controller_id":"111",   // id контроллера
	"language":"ru-RU",
	"hostname":"alarm-system",
	"wifi_mode":1,   // 1 - STA, 2 - AP
	"wifi_sta_type":1, // 0 - STATIC, 1 - DHCP
	"wifi_sta_ssid":"SSID",
	"wifi_sta_pass":"PASSWORD",
	"wifi_sta_ip":"192.168.0.101",
	"wifi_sta_mask":"255.255.255.0",
	"wifi_sta_gw":"192.168.0.1",
	"wifi_sta_dns1":"208.67.222.222",
	"wifi_sta_dns2":"208.67.222.222",
	"wifi_ap_authmode": 3, // 0 - OPEN, 1 - WEP, 2 - WPA_PSK, 3 - WPA2_PSK, 4 - WPA_WPA2_PSK
	"wifi_ap_hidden":0, // 0/1
	"wifi_ap_channel":1, // 1...14
	"wifi_ap_ssid":"SMARTHOME_000000000000",
	"wifi_ap_pass":"00000000",
	"wifi_ap_ip":"192.168.4.1",
	"wifi_ap_mask":"255.255.255.0",
	"wifi_ap_gw":"192.168.4.1",
	"httpd_port":80, // 1...65535
	"httpd_auth":0, // 0/1
	"httpd_user":"admin",
	"httpd_pass":"admin",
	"ntp_enable":0, // 0/1
	"ntp_host":"time.windows.com",
	"ntp_tz":3, // -11...13
	"upnp_enable":1, // 0/1
	"advanced_mode":0, // 0/1 
	"app_afb_enable":1, // 0/1
	"app_leds_off":1, // 0/1
	"app_alarm_duration":10, // minutes
	"app_arming_delay":0, // seconds
	"app_portal_link":0, // 0/1
	"app_rf_freq":2, // 1 - 315Mhz, 2 - 433Mhz
	"app_rf_power":3, // 0 - 1DBM, 1 - 2DBM, 2 - 5DBM, 3 - 8DBM, 4 - 11DBM, 5 - 14DBM, 6 - 17DBM, 7 - 20DBM
	"app_button_action":1, // 0 - NONE, 1 - ARMING, 2 - RUN_ACTION, 3 - SEND_CODE
	"app_button_rec_id":0, // ID
	"gsm_pin":"1234",
	"gsm_allowed_phones":"", // список через запятую
	"gsm_sendto_phones":"", // список через запятую
	"gsm_callto_phones":"", // один номер
	"gsm_smsin_enable":"0", // 0/1
	"gsm_smsout_enable":"0", // 0/1
	"gsm_call_enable":"0", // 0/1
	"gprs_enable":"1", // 0/1
	"gprs_apn":"", "internet.mts.ru",
	"gprs_user":"mts",
	"gprs_pass":"mts",
	"gsm_enable":"0", // 0/1
	"ebus_enable":0, // 0/1
	"command":"xxx",
	"response":"0"
}

Изменение конфигурации контроллера(config-set)

Запрос:

Request URL: [site]/api/ctrl/config-set/

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

(string) token,
(int) controller_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"controller_id" : 111,
	"command": "yyy"    // параметры контроллера смотри метод Получить конфигурацию контроллера(ctrl/config/)
}

Ответ:

Пример ответа (data):

{
	"result": "Ok"
}

Передача локального IP Контроллера (get-ip)

Запрос

Request URL: [site]/api/ctrl/get-ip

Request Params:

token (required): string(64);
controller_id (required): int;

Ответ:

Пример ответа:

{
	data:'192.168.0.15',
	error: null
}

Установка подписки на Контроллере

Запрос:

Request URL: [site]/in/subscription/set”

Ответ:

Пример ответа (data):

{
	"seq_id": 0,
	"id": 1, // ID подписки (см. ниже)
	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
}

Просмотр статуса подписки (get-subscribe-status)

Запрос:

Request URL: [site]/api/ctrl/get-subscribe-status

Параметры:

token (required): string(64)
controller_id (required): int

Ответ:

Пример ответа (data):

{
	data:{
		id: 1,
		controller_id: 40,
		user_id: 424,
		remain_time: 100,
		request_time: 1355314332,
		response_time: 1355315332,
		success: 0
	},
	error: ''
}

Активация/продление/покупка подписки (set-subscribe)

Запрос:

Request URL: [site]/api/ctrl/set-subscribe

Параметры:

token (required): string(64)
controller_id (required): int

Ответ:

{
	data:{
		id: 1,
		controller_id: 40,
		user_id: 424,
		remain_time: 100,
		request_time: 1355314332,
		response_time: 1355315332,
		success: 0
	},
	error: ''
}

Метод получения списка телефонов (get-phones)

Запрос:

Request URL: [site]/api/ctrl/get-phones

Параметры:

token (required): string, 64
controller_id (required): int
type (optional): string,
range ['recipient', 'authorized', 'all'], (default: 'all')

Ответ:

Пример ответа:

{
	'error': null,
	data: [
		{'id': 5, 'phone': '+380123456789'},
		{'id': 6, 'phone': '+380123334455'},
		{'id': 7, 'phone': '+380112223344'}
	]
}

Редактирование телефона (edit-phone)

Запрос:

Request URL: [site]/api/ctrl/edit-phone

Параметры:

token (required): string, 64
phone_id (required): int
is_recipient (optional): int
is_authorized (optional): int
phone (optional): string

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"id":2,
		"controller_id":81,
		"phone":"+380503334455",
		"is_recipient":"1",
		"is_authorized":0
	}
}

Удаление телефона (delete-phone)

Запрос:

Request URL: [site]/api/ctrl/delete-phone

Параметры:

token (required): string, 64
phone_id (required): int

Ответ:

Пример ответа:

{
	"error":null,
	"data":{"response":"OK"}
}

Добавление телефона (add-phone)

Запрос:

Request URL: [site]/api/ctrl/add-phone

Params:

token (required): string, 64
controller_id (required): int
phone (required): string
is_recipient (optional): int
is_authorized (optional): int

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"id":2,
		"controller_id":81,
		"phone":"+380503334455",
		"is_recipient":"1",
		"is_authorized":0
	}
}

Информация о версии прошивки контроллера (fw-version-current)

Запрос:

Request URL: [site]/api/ctrl/fw-version-current/

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 1 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"version_id":1,
	"version_name":"0.01",
	"tag":"OLD",
	"url":"\/controllers_fw\/NULL.bin",
	"date":"16.10.2018",
	"new_version_id":38   // если "new_version_id" != "version_id" значит имеется новая версия.
}

Информация о последней версии прошивки контроллера (get-new-fw-version)

Запрос:

Request URL: [site]/api/ctrl/get-new-fw-version/

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 1 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"version_id":38,
	"version_name":"0.14",
	"tag":"0.14 \/ Oct 5 2018 16:49:04",
	"url":"\/controllers_fw\/tls-smarthome-hw-9_0.14.bin",
	"date":"16.10.2018"
}

Устройства

Получение списка устройств пользователя (list)

Запрос:

Request URL: [site]/api/device/list

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 1 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
"0":{
	"id":"122",
	"external_id":"19", //id на контроллере
	"controller_id":"6",
	"name":"Сирена",
	"type_id":"2",  //тип устройства
	"codes":":{     //коды (кнопки)
		"0":{
		"id":"218",
		"external_cod_id":"32",
		"device_id":"122",
		"name":"ON",
		"code":"3675192",
		"protocol":"1",
		"pulse_len":null,
		"group_1":"1",
		"group_2":"0",
		"group_3":"0",
		"group_4":"0",
		"group_5":"0",
		"group_6":"0",
		"group_7":"0",
		"group_8":"0",
		"active":"1"
		}, 
		"1":{ ... }
	},
	"state":"1",
	"on_dashboard":"1", //показывать на главной
	"active":"1"  
},
"1":{
	"id":"120",
	"external_id":"22",
	"controller_id":"6",
	"name":"Пульт 4кн бел",
	"type_id":"3",
	"codes": ... ,
	"state":"1",
	"on_dashboard":"0",
	"active":"1"
	}
}

Информация об устройстве (info)

Запрос:

Request URL: [site]/api/device/info/

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

(int) controller_id,
(int) device_id,
(string) token

Пример запроса:

{
	"controller_id": 1 ,
	"device_id": 122,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"id":"122",
	"external_id":"19",
	"controller_id":"6",
	"name":"Сирена",
	"type_id":"2",
	"codes"
		"0"
			"id":"218",
			"external_cod_id":"32",
			"device_id":"122",
			"name":"ON",
			"code":"3675192",
			"protocol":"1",
			"pulse_len":null,
			"group_1":"1",
			"group_2":"0",
			"group_3":"0",
			"group_4":"0",
			"group_5":"0",
			"group_6":"0",
			"group_7":"0",
			"group_8":"0",
			"active":"1",
		},
		"1"
			"id":"219",
			"external_cod_id":"33",
			"device_id":"122",
			"name":"OFF",
			"code":"3675186
		...
		}
	},
	"state":"1",
	"on_dashboard":"1",
	"active":"1",
	"alias":"xxx",
	"send_sms ":0,
	"voice_call":0,
	place"
		"name":null,
		"color":null
		}
}

Обновление информации об устройстве (update)

Запрос:

Request URL: [site]/api/device/update/

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

(int) device_id,
(string) name,
(int) active,
(string) token,

Пример запроса (data):

{
	"device_id": 107,   // local device id
	"name": "New name", // new name
	"active": 1,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"result" : "Ok"
}

Удаление устройства (delete)

Запрос:

Request URL: [site]/api/device/delete/

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

(int) device_id,
(string) token

Пример запроса:

{
	"device_id": 107,   // local device id
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"result" : "Ok"
}

Получение метеоданных (last)

Запрос:

Request URL: [site]/api/device/meteo-last/

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

(string) token,
(int) device_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 130
}

Ответ:

Пример ответа (data):

{
	"id":"4046",
	"controller_name":"AS_7FD6785CCF5D",
	"internal_id":"55",
	"device_id":"130",
	"name":"7",
	"temp":"240",
	"hum":"245",
	"illum":"0",
	"pres":"1239",
	"volt":"32",
	"date_time":"2016-03-02 21:09:40",
	"new":"0"  
}

Получение метеоданных за период (period)

Запрос:

Request URL: [site]/api/device/meteo-period/

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

(string) token,

(int) device_id,

(int) period

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 130,
	"period": 1 // количество дней 
}

Ответ:

параметры ответа (array to objects):

Пример ответа (data):

[
	{
	"id":"4065",
	"controller_name":"AS_7FD6785CCF5D",
	"internal_id":"55",
	"device_id":"130",
	"name":"7",
	"temp":"240",
	"hum":"523",
	"illum":"0",
	"pres":"1239",
	"volt":"32",
	"date_time":"2017-07-30 21:11:07",
	"new":"0"
	},
	{
	"id":"4067",
	"controller_name":"AS_7FD6785CCF5D
	...
	},
]

Получение данных электропитания (last)

Запрос:

Request URL: [site]/api/device/electro-last/

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

(string) token,
(int) device_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 130
}

Ответ:

Пример ответа (data):

{
	"id":"318",
	"controller_id":"11",
	"external_id":"2",
	"device_id":"125",
	"name":"23",
	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
	"last_seen":"2017-07-21 04:20:27",
	"available":"1",
	"voltage":"24",
	"have_voltage":"1",
	"current":"2147483647",
	"have_current":"1",
	"supp_voltage":"33",
	"date_create":"2017-07-21 01:20:33",
	"new":"0"
}

Получение данных электропитания за период (period)

Запрос:

Request URL: [site]/api/device/electro-period/

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

(string) token,
(int) device_id,
(int) period

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 130,
	"period": 1 // количество дней 
}

Ответ:

Параметры ответа: (array to objects)

Пример ответа (data):

[
	{
	"id":"318",
	"controller_id":"11",
	"external_id":"2",
	"device_id":"125",
	"name":"23",
	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
	"last_seen":"2017-07-21 04:20:27",
	"available":"1",
	"voltage":"24",
	"have_voltage":"1",
	"current":"2147483647",
	"have_current":"1",
	"supp_voltage":"33",
	"date_create":"2017-07-21 01:20:33",
	"new":"0"
	},
	{
	"id":"318",
	"controller_id":"11",
	...
	},
]

Получение данных о сторонних устройствах (other-last)

Метод возвращает информацию о последнем обнаруженном стороннем устройстве.

Запрос:

Request URL: [site]/api/device/other-last/

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

(string) token,
(int) device_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 118
}

Ответ:

Пример ответа (data):

{
	"id":"1301",
	"controller_id":"6",
	"device_id":"118",
	"name":"Розетка",
	"code":"81",
	"pulse_len":null,
	"bit_len":null,
	"protocol":null,
	"groups":null,
	"type":null,
	"date_time":"2017-08-21 04:55:18",
	"active":null,
	"new":"1"
}

Получение данных о сторонних устройствах за период (other-period)

Запрос:

Request URL: [site]/api/device/other-period/

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

(string) token,
(int) device_id,
(int) period

Пример запроса:

 
{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 118,
	"period": 1 // количество дней 
}

Ответ:

Пример ответа (data):

{
	"id":"1301",
	"controller_id":"6",
	"device_id":"118",
	"name":"Розетка",
	"code":"81",
	"pulse_len":null,
	"bit_len":null,
	"protocol":null,
	"groups":null,
	"type":null,
	"date_time":"2017-08-21 04:55:18",
	"active":null,
	"new":"1"
	},
	{
	"id":"4067",
	"controller_id":"6",
	...
}

Wizard добавления устройств

Датчик открытия двери (create-door-open-sensor)

Запрос:

URL: [site]/api/wizard/create-door-open-sensor

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

controller_id (required): int
token (required): string, 64
device_name (optional): string, 256
code_ready (optional): string, 64 //Название кода готовности
code_alarm (optional): string, 64 //Название кода оповещания
code_low_battery (optional): string, 64 //Название кода садящейся батареи

Ответ:

Пример ответа:

{
	data:{
		'response': 'OK'
		},
	error: null
}

После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.

Датчик затопления (create-flood-sensor)

Запрос:

Request URL: [site]/api/wizard/create-flood-sensor

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

controller_id (required): int
token (required): string, 64
device_name (optional): string, 256
code_alarm (optional): string, 64 //Название кода оповещения
code_tamper (optional): string, 64 //Название кода вмешательства
code_low_battery (optional): string, 64 //Название кода садящейся батареи

Ответ:

Пример ответа:

{
	data: {
		'response': 'OK'
		},
	error: null
}

После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.

Пульт,4 кнопки (create-console)

Запрос:

Request URL: [site]/api/wizard/create-console

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

controller_id (required): int
token (required): string, 64
device_name (optional): string, 256
code_lock (optional): string, 64 //Название кода блокировки
code_unlock (optional): string, 64 //Название кода разблокировки
code_s (optional): string, 64 //Название кода s
code_alarm (optional): string, 64 //Название кода оповещения

Ответ:

Пример ответа:

{
	data: {
		'response': 'OK'
	},
	error: null
}

После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.

Сирена (create-siren)

Запрос:

Request URL: [site]/api/wizard/create-siren

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

controller_id (required): int
token (required): string, 64
device_name (optional): string, 256
code_on (optional): string, 64 //Название кода включения
code_off (optional): string, 64 //Название кода выключения
code_blank (optional): string, 64 //Название кода blank

Ответ:

Пример ответа:

{
	data: {
		'response': 'OK'
		},
	error: null
}

Перед отправкой параметров необходимо перевести сирену в режим обучения.

Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos)

Запрос:

Request URL: [site]/api/wizard/get-meteos

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

controller_id (required): int
token (required): string, 64

Ответ:

Пример ответа:

{
	"error":null,
	"data":[
			{
			"id":"93",
			"controller_id":"79",
			"date":"1528389351",
			"type":"7",
			"family":"0",
			"rf_code":null,
			"rf_bit_len":null,
			"rf_pulse_len":null,
			"rf_protocol":null,
			"rf_freq":null,
			"ir_code":null,
			"ir_bit_len":null,
			"ir_address":null,
			"ir_protocol":null,
			"meteo_num":"0"
			}
		]
}

Метеостанция: добавление (create-meteo)

Запрос:

Request URL: [site][site]/api/wizard/create-meteo

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

controller_id (required): int
token (required): string, 64
meteo_num (required): int //Получается в списке выше
device_name (optional): string, 256

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"response":"OK"
		}
}

Водопроводный кран

Порядок добавления крана:

1) Сгенерировать коды

2) Зажать на кране кнопку, пока кран не мигнёт трижды

3) Отправить один код

4) Нажать на кране кнопку однократно

5) Зажать на кране кнопку, пока не мигнёт 4 раза

6) Отправить второй код из сгенерированных

7) Нажать на кране кнопку однократно

8) Отправить запрос на создание крана.

Генерация кодов

Запрос:

Request URL: [site]/api/wizard/create-codes

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

controller_id (required): int
token (required): string, 64

Ответ:

Пример ответа:

{
	"error":null,
	"data":
		{
			"response":{
					"id":30,
					"masks":"[6,4,0,1]",
					"code_1":"9920950",
					"code_2":"9920948",
					"code_3":"9920944",
					"code_4":"9920945"
				}
		}
}

Выполнение кода

Запрос:

Request URL: [site]/api/wizard/execute-code

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

controller_id (required): int
token (required): string, 64
code (required): int // Берется из сгенерированных

Ответ:

Пример ответа:

{
	error: null,
	data: {
		"response":"OK"
		}
}

Добавление крана

Запрос:

Request URL: [site]/api/wizard/create-crane-by-codes

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

controller_id (required): int
token (required): string, 64
code_1 (required): int
code_2 (required): int
device_name (optional): string, 256
code_open (optional): string, 64 //Название кода открытия
code_close (optional): string, 64 //Название кода закрытия

Ответ:

Пример ответа:

{
	data:{'response': 'OK'},
	error: null
}

Добавление розетки

Порядок добавления розетки следующий:

1) Сгенерировать коды

2) Зажать на розетке кнопку, пока она не начнет мигать

3) Отправить один код

4) Зажать на розетке кнопку, пока она не начнет мигать

5) Отправить второй код из сгенерированых

6) Отправить запрос на создание розетки

Генерация кодов (create-codes)

Запрос:

Request URL: [site]/api/wizard/create-codes

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

controller_id (required): int
token (required): string, 64
socket (required): любое значение.

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
		}
}

Выполнение кода (execute-code)

Запрос:

Request URL: [site]/api/wizard/execute-code

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

controller_id (required): int
token (required): string, 64
code (required): int // Берется из сгенерированных

Ответ:

Пример ответа:

{
	error: null,
	data: {'response' => 'OK'}
}

Добавление розетки (create-socket)

Запрос:

Request URL: [site]/api/wizard/create-socket

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

controller_id (required): int
token (required): string, 64
code_1 (required): int
code_2 (required): int
device_name (optional): string, 256
code_off (optional): string, 64 //Название кода открытия
code_on (optional): string, 64 //Название кода закрытия

Ответ:

Пример ответа:

{
	data: {'response':'OK'},
	error: null
}

Сценарии

Получение списка сценариев (list)

Запрос:

Request URL: [site]/api/scheduler/list/

Параметры запроса: (string) token

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа:

{
"error":null,
"data"
	"schedulers":[
	{
		"id":83,
		"external_id":23,
		"name":"Test 444",
		"operation":"local",
		"armed":2,
		"type":"meteo",
		"active":0,
		"action"
			"action_id":1,
			"controller_id":109,
			"device_id":1747,
			"code_id":1100,
			"device_external_id":64,
			"armed":1,
			"groups":7,
			"sensor_type":"1",
			"date":"00:00",
			"repetition":"1",
			"logic_operation":"=",
			"value":"9"
		},
		"target"
			"target_id":2,
			"controller_id":109,
			"device_id":0,
			"device_external_id":0,
			"code_id":0,
			"external_cod_id":0,
			"armed":0,
			"groups":168
		}
		},
		{
		"id":84,
		"external_id":24,
		...
		}]
	}
}

Обновление/добавление сценариев (update)

Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера"); на втором этапе обновляется информация о каждом действии.

Запрос:

Request URL: [site]/api/scheduler/update/

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

(int) controller_id,
(string) token

Пример запроса:

{
	"controller_id": 6 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
}

Ответ:

Пример ответа:

{
	"result": "Ok" // ответ что запрос ушел
}

Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)

Информация о сценарии (info)

Запрос:

Request URL: [site]/api/scheduler/info/

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

(int) scheduler_id,
(string) token

Пример запроса:

{
	"scheduler_id": 122,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
"id":107,
"external_id":6,
"name":"Test 1.1.1",
"operation":"local",
"armed":1,
"type":"device",
"active":1,
"action":{
	"action_id":1,
	"controller_id":111,
	"device_id":1824,
	"code_id":1399,
	"device_external_id":18,
	"armed":0,
	"groups":0,
	"sensor_type":"0",
	"date":null,
	"repetition":"0",
	"logic_operation":"=",
	"value":null
},
"targets":[
		{
		"id":87,
		"type_id":3,
		"controller_id":111,
		"device_id":0,
		"code_id":0,
		"device_external_id":0,
		"armed":1,
		"groups":0
		},
		{
		"id":88,
		"type_id":1,
		"controller_id":113,
		"device_id":13,
		"code_id":123,
		"device_external_id":1234,
		"armed":0,
		"groups":0
		},
	]
}

Обновление сценариев (update)

Обновление состоит из двух запросов: 1) обновление действия, вызывающего событие; 2) обновления целей сработки. При этом запросы можно делать независимо друг от друга.

Обновление/добавление действий и событий сценария (Update-action)

Request URL: [site]/api/scheduler/update-action/

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

(int) scheduler_id,
(string) token,
(string) name,
(int) "active"
(int) "send_sms" // 1 - отправлять / 0 - не отправлять
(int) "make_call" // 1 - отправлять / 0 - не отправлять
(int) "armed" // 0 - в любом режиме, 1 - в режиме охраны, 2 - без режима охраны
(int) "action_id",
(int) "action_device_id",
(int) "action_code_id",
(int) "action_armed",
(int) "action_groups", // битовая маска группы от 1 до 8
(string) "action_repetition", // только для расписания: номер дней повторения через запятую от 1 до 7
(string) "action_event_time", // только для расписания: время повторения
(int) "action_sensor_type", // только для метео устройств: 1 - напряжение, 2 - температура, 3 - влажность, 4 - Атм. давление, 5 - Освещенность , 0 - не выбрано
(string) "action_logic_operation", // логическая операция : '=', '!=', '<', '>', '<=', '>=', 'in', 'like'
(int) "action_value"

Пример запроса:

{
	"scheduler_id": 6 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"name": "New name",
	"active": 1,
	"send_sms": 0, 
	"make_call": 1,
	"armed": 2,    
	"action_id" : 2,
	"action_device_id" : 2,
	"action_code_id" : 4,
	"action_armed" : 0,
	"action_groups" : 7,   
	"action_repetition" : "1,3",  
	"action_event_time" : "10:00",   
	"action_sensor_type" : 2, 
	"action_logic_operation" : "=",   
	"action_value" : 35,   
}

Ответ:

Пример ответа:

{
	"result": "Ok" // ответ о том, что запрос отправлен.
}

Обновление цели события (Update-target)

Request URL: [site]/api/scheduler/update-target/

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

(int) target_id,
(string) token,
(int) "target_type_id",
(int) "target_device_id",
(int) "target_code_id",
(int) "target_armed",
(int) "target_groups", // битовая маска группы от 1 до 8

Пример запроса:

{
	"target_id": 6 ,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",   
	"target_type_id" : 2,
	"target_device_id" : 2,
	"target_code_id" : 4,
	"target_armed" : 0,
	"target_groups" : 7
}

Ответ:

Пример ответа:

{
	"result": "Ok" // ответ о том, что запрос отправлен.
}

Логи пользователя (logs)

Запрос:

Request URL: [site]/api/profile/logs/

Параметры запроса: (string) token, (int) page, (int) limit

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"page": 1 // номер страницы лога
	"limit": 20 // количество логов на странице , по умолчанию 20, максимум 100
}

Ответ:

Пример ответа:

[
	{
	"id":15,
	"controller":"Test Valera",
	"action_name":"",
	"device":"",
	"cod":"",
	"action_pack":"",
	"date_create":"2019-06-20 15:57:26",
	"status":0
	},
	{
	"id":14,
	"controller":"Test Valera",
	"action_name":"",
	"device":"",
	"cod":"",
	"action_pack":"",
	"date_create":"2019-06-20 15:57:18",
	"status":0	
        }
]

Коды

Получение информации о коде (info)

Запрос:

Request URL: [site]/api/property/info/

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

(int) controller_id,
(int) device_id,
(int) code_id,
(string) token

Пример запроса:

{
	"controller_id": 6,
	"device_id": 109, 
	"code_id": 192,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
	"id":"1465",
	"external_cod_id":"59",
	"device_id":"1866",
	"name":"alarm",
	"alias":"xxx",
	"code":"15779537",
	"msg_cod":"003001",
	"send_armed":"INFO",
	"send_disarmed":"INFO",
	"protocol":"1",
	"pulse_len":null,
	"group_1":"0",
	"group_2":"0",
	"group_3":"0",
	"group_4":"0",
	"group_5":"0",
	"group_6":"0",
	"group_7":"0",
	"group_8":"0",
	"active":"1",
	"send_sms":"0",
	"voice_call":"0"
}

Изменение имени кода (update-code-name)

Запрос: Request URL: [site]/api/device/update-code-name

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

token (required): string(64)
code_id (required): int
name (optional): string(255)

Ответ:

Пример ответа:

{
	data: {
		'message': "OK"
		},
	error: null
}

Редактирование параметров кода (update)

Запрос:

Request URL: [site]/api/property/update/

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

(string) token
(int) device_id
(int) code_id
(string) name // опционально
(int) active // опционально
(int) send_sms // опционально
(int) voice_call // опционально

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id" : 111,
	"code_id" : 111,
	"send_sms": 1
}

Ответ:

Пример ответа (data):

{
	"result": "Ok"
}

Получение кодов по типу сигнала (get-codes-by-subtype)

Запрос:

Request URL: [site]/api/device/get-codes-by-subtype

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

token (required): string(64)
device_subtype_id (optional): int, default 0.

Ответ:

Пример ответа:

{
	"code"
	"id":131,
	"controller_id":109,
	"device_type_id":0,
	"device_subtype_id":1,
	"code":"655370",
	"protocol":1,
	"bit_len":24,
	"pulse_len":283,
	"freq":2,"address":null,
	"num":null,
	"date_create":"2019-03-13 17:35:05",
	"device_id":null
	},
	"devices":[
	{
		"id":"1684",
		"external_id":"64",
		"controller_id":"109",
		"name":"WS 1",
		"alias":null,
		"type_id":"12",
		"password":null,
		"codes":[178,179,180],
		"state":"1",
		"on_dashboard":"0",
		"active":"1",
		"new":"1",
		"family":"DEVICE_FAMILY_RADIO",
		"camera_id":null,
		"camera_host":null,
		"send_sms":"0",
		"voice_call":"0"
	},
	{
		"id":"1738",
		"external_id":"115",
		"controller_id":"109",
		"name":"Pult 123",
		"alias":null,
		"type_id":"3",
		"password":null,
		"codes":[280,281,282,283],
		"state":"1",
		"on_dashboard":"0",
		"active":"1",
		"new":"1",
		"family":"DEVICE_FAMILY_RADIO",
		"camera_id":null,
		"camera_host":null,
		"send_sms":"0",
		"voice_call":"0"
	}
	]
}

Получение списка кодов (get-codes)

Запрос:

Request URL: [site]/api/device/get-codes

Параметры:

token (required): string 64
controller_id (required): int

Ответ:

Пример ответа:

{
	data: [
		{
			devices:	[
			{
				id:	13
				external_id:	7,
				controller_id:	5,
				name:	"Simple device",
				type_id:	2,
				password:	null,
				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
				state:	1,
				on_dashboard:	0,
				active:	1,
				new:	1,
				family:	DEVICE_FAMILY_RADIO,
				camera_id:	null,
				camera_host:	null
			},
			{
				id:	14
				external_id:	8,
				controller_id:	5,
				name:	"Simple device",
				type_id:	2,
				password:	null,
				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
				state:	1,
				on_dashboard:	0,
				active:	1,
				new:	1,
				family:	DEVICE_FAMILY_RADIO,
				camera_id:	null,
				camera_host:	null
			},
		],
		code: {
			id:	12,
			controller_id: 5,
			device_type_id:	2,
			code: 498654,
			protocol: 1,
			bit_len: 32,
			pulse_len:	86,
			freq:	77,
			address:	94,
			num:	1,
			date_create: '2018-04-13 18:29:11"

		}
		}, 

		{
			devices:	[
			{
				id:	13
				external_id:	7,
				controller_id:	5,
				name:	"Simple device",
				type_id:	2,
				password:	null,
				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
				state:	1,
				on_dashboard:	0,
				active:	1,
				new:	1,
				family:	DEVICE_FAMILY_RADIO,
				camera_id:	null,
				camera_host:	null
			},
			{
				id:	14
				external_id:	8,
				controller_id:	5,
				name:	"Simple device",
				type_id:	2,
				password:	null,
				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
				state:	1,
				on_dashboard:	0,
				active:	1,
				new:	1,
				family:	DEVICE_FAMILY_RADIO,
				camera_id:	null,
				camera_host:	null
			},
		],
		code: {
			id:	12,
			controller_id: 5,
			device_type_id:	2,
			code: 498654,
			protocol: 1,
			bit_len: 32,
			pulse_len:	86,
			freq:	77,
			address:	94,
			num:	1,
			date_create: '2018-04-13 18:29:11"

		}
		}, 
	},
	error: null,
}

Добавление кода к устройству (set-code-to-device)

Запрос:

Request URL: [site]/api/device/set-code-to-device

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

token (required): string 64
code_id (required): int
device_id (required): int
name (optional): string 256

Ответ:

Пример ответа:

{
	data:	{
		id: 5,
		external_cod_id: 15,
		device_id: 14,
		name: "Name"
		code: 8463517,
		protocol: 0,
		pulse_len:	86, 
		active: 1,
	},
	error: null
}

Удаление кода (remove-code)

Запрос:

Request URL: [site]/api/device/remove-code

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

token (required): string 64
code_id (required): int

Ответ:

Пример ответа:

{
	data:	{
		message: "OK"
	},
	error: null
}

События

Нажатие кнопки на устройстве (event)

Запрос:

Request URL: [site]/api/device/event/

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

(string) controller_name,
(int) device_external_id,
(int) cod_external_id,
(string) token,
(int) device_type

Пример запроса:

{
	"controller_name": " AS_7F26335CCF4B" ,
	"device_external_id": 19,
	"cod_external_id": 1,
	"device_type": 1,
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

так как MQTT односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен: response:

Ответ:

Пример ответа (data):

{
	"result": "Ok"
}

Места

Получение списка мест (places-list)

Запрос:

Request URL: [site]/api/places/places-list

Параметры запроса: token (required): string, 64

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"rooms":[
				{
				"id":1,
				"root_id":1,
				"user_id":424,
				"lvl":0,
				"name":"Дом",
				"icon":0,
				"icon_type":1,
				"color":"#fff2cc",
				"readonly":0,
				"visible":1
				},
				{
				"id":2,
				"root_id":1,
				"user_id":424,
				"lvl":1,
				"name":"Спальня",
				"icon":0,
				"icon_type":1,
				"color":"#b6d7a8",
				"readonly":0,
				"visible":1
				}
			]
		}
}

Создание места (create)

Запрос:

Request URL: [site]/api/places/create

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

token (required): string, 64
root (optional): int, default 1
lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
lvl (optional): int, default 0
name (optional): string, 64, default 'Simple name'
icon (optional): string, default //Допускаемые параметры -- ключи объекта выше
color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
active (optional): int, default 1
selected (optional): int, default 0
disabled (optional): int, default 0
readonly (optional): int, default 0
visible (optional): int, default 1
collapsed (optional): int, default 0
movable_u (optional): int, default 1
movable_d (optional): int, default 1
movable_l (optional): int, default 1
movable_r (optional): int, default 1
removable (optional): int, default 1
removable_all (optional): int, default 0
inverse_text (optional): string, default 'black'

Ответ:

Пример ответа:

{
	error:null,
	data: {'message': 'OK'}
}

Редактирование места (edit)

Запрос:

Request URL: [site]/api/places/edit

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

token (required): string, 64
place_id (required): int
root (optional): int, default 1
lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
lvl (optional): int, default 0
name (optional): string, 64, default 'Simple name'
icon (optional): string, default //Допускаемые параметры -- ключи объекта выше
color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
active (optional): int, default 1
selected (optional): int, default 0
disabled (optional): int, default 0
readonly (optional): int, default 0
visible (optional): int, default 1
collapsed (optional): int, default 0
movable_u (optional): int, default 1
movable_d (optional): int, default 1
movable_l (optional): int, default 1
movable_r (optional): int, default 1
removable (optional): int, default 1
removable_all (optional): int, default 0
inverse_text (optional): string, default 'black'

Ответ:

Пример ответа:

{
	error:null,
	data: {'message': 'OK'}
}

Удаление места (delete)

Запрос: Request URL: [site]/api/places/delete

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

token (required): string, 64
place_id (required): int

Ответ:

Пример ответа:

{
	error:null,
	data: {'message': 'OK'}
}

Добавление устройства к месту, смена места у устройства (device-in-place)

Запрос:

Request URL: [site]/api/places/device-in-place/

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

token (required): string 64
device_id (required): int
place_id (required): int
visible (not required): int

Ответ:

Пример ответа:

{
	data:	{result: "OK"},
	error: null
}

Отвязать устройство от месту (device-out-place)

Запрос:

Request URL: [site]/api/places/device-out-place/

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

token (required): string 64
device_id (required): int
place_id (required): int

Ответ:

Пример ответа:

{
	data:	{
		result: "OK"
	},
	error: null
}

Получить список связей устройство-место (device-place-list)

Запрос:

Request URL: [site]/api/places/device-place-list/

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

token (required): string 64

Ответ:

Пример ответа:

{
	"error":null,
	"data":{
		"0":{
			"device_id":1336,
			"device_name":"Camera test",
			"place_id":8,
			"place_name":"office"
			},
			...
		"10":{
			"device_id":1865,
			"device_name":"Meteo 9",
			"place_id":10,
			"place_name":"Box 1"
			}
		}
}

Активация подписки Ebus

Получение состояния подписки на Контроллере - “in/subscription/get”:

{
	"id": 1, // ID подписки (см. ниже)
	"seq_id": 0
}

Ответ:

{
	"seq_id": 0,
	"remain_time": 100, // оставшееся время в секундах, 4294967295 – неограниченно
	"success": 0/1
}

Установка подписки на Контроллере - “in/subscription/set”:

{
	"seq_id": 0,
	"id": 1, // ID подписки (см. ниже)
	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
}

Ответ:

{
	"seq_id": 0,
	"success": 0/1
}

Идентификаторы подписок: SUBSCRIPTION_EBUS = 1

Статус Контроллера

Контроллер отправляет информацию о своем онлайн/оффлайн статусе в топик “out/status”.

Формат сообщения:

{
	"status": 1 // см. ниже
}

Поле “status” может принимать следующие значения:

• "0" – оффлайн

• "1" – онлайн

• "2" – онлайн, после включения питания

При получении сообщения со статусом "2", портал должен отправить Контроллеру информацию о пользовательских подписках, как это описано в разделе «Подписки».

Виджеты

Список виджетов пользователя (widget-list)

Запрос:

Request URL: [site]/api/device/widget-list/

Параметры запроса: (string) token

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
}

Ответ:

Пример ответа (data):

{
"widgets":[
	{
	"controller_id":111,
	"device_ids":[18,20,21,22],
	"device_id":"1824",
	"external_id":18,
	"device_type":3,
	"name":"Remote control",
	"widget_type":3,
	"state":1
	},
	{
	"controller_id":111,
	"device_ids":[18,20,21,22],
	"device_id":"1850",
	"external_id":20,
	"device_type":4,
	"name":"Sockets",
	"widget_type":4,
	"state":1
	}
   ],
"ctrl_widgets":[
   {
	"controller_id":111,
	"name":"66D4E809EF0A",
	"hostname":"Test",
	"armed":0
   }
]
}

Добавить виджет (widget-add-home)

Запрос:

Request URL: [site]/api/device/widget-add-home/

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

(string) token,
(int) device_id,
(int) controller_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"controller_id": 1862
}

Ответ:

Пример ответа (полный):

{
	"error":null,
	"data":{
	"result":"Ok"
	}
}

Удалить виджет пользователя (widget-remove-home)

Запрос:

Request URL: [site]/api/device/widget-remove-home/

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

(string) token,
(int) device_id,
(int) controller_id

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"device_id": 1862
}

Ответ:

Пример ответа (полный):

{
	"error":null,
	"data":{
		"result":"Ok"
	}
}

Неклассифицируемые методы

Список доступных стран (countries)

Запрос:

Request URL: [site]/api/profile/countries/

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

(string) token
(string) lang // en , ua, ru

Пример запроса:

{
	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
	"lang" : "en"
}

Ответ:

Пример ответа (data):

[
	{
		"id":"1",
		"code":"AF",
		"name":"Afghanistan"
	},
	{
		"id":"2",
		"code":"AL",
		"name":"Albania"
	}
]

Ошибки

параметры ошибки:

пример:

{
	"errors":{
		"password": [
			"Incorrect username."
		]
	}
}

@@ Строка 1: / Строка 1: @@
+<languages />
+<translate>
+<!--T:1-->
 * API v01 *
+<!--T:2-->
 API ( json )
+<!--T:3-->
 URL https://quadrobit.com/
-= Учётная запись =
+= Общие сведения =
+Обмен данными между Пользователем и серверной частью системы Quadrobit Smart Home осуществляется путём отправки пакетов (запросов и ответов).
+Пакет отправляется по HTTP методом POST на указанный адрес Request URL.
+Запрос может содержать JSON-структуру, включающую один или несколько параметров.
+После успешной авторизации Пользователя запрос всегда должен содержать параметр token.
+В ответ на полученный запрос Сервер возвращает Пользователю следующую JSON-структуру:
+<pre>
+{
+	error: null,
+	data: { ... }
+}
+</pre>
+Параметр error содержит информацию о результате выполнения запроса. error: null - запрос выполнен успешно.
+Структура и содержание параметра data определяется типом запроса.
+= Учётная запись = <!--T:4-->
 == Авторизация (login) ==
-request:
+<!--T:5-->
+Запрос:
+<!--T:6-->
 Request URL: [site]/api/login
-параметры запроса:
+<!--T:7-->
+Параметры запроса:
-(string) email,
+<!--T:8-->
+#(string) email,
-(string) password
+#(string) password
+<!--T:10-->
 Пример запроса:
 <pre>
@@ Строка 26: / Строка 57: @@
 </pre>
-response:
+<!--T:11-->
-параметры ответа: (object)
+Ответ:
-Пример ответа:
+<!--T:12-->
+Пример ответа (data):
 <pre>
 {
@@ Строка 45: / Строка 77: @@
 }
+<!--T:13-->
 </pre>
-== Регистрация (registration) ==
+== Регистрация (registration) == <!--T:14-->
+<!--T:15-->
+Запрос:
-request:
 Request URL: [site]/api/registration
-параметры запроса:
+<!--T:16-->
+Параметры запроса:
-(string) email,
+<!--T:17-->
+#(string) email,
-(string) password
+#(string) password
+<!--T:19-->
 Пример запроса:
 <pre>
@@ Строка 66: / Строка 103: @@
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (object)
-пример:
+Пример ответа (data):
 <pre>
 {
@@ Строка 83: / Строка 120: @@
-== Профиль пользователя (profile) ==
+== Профиль пользователя (profile) == <!--T:20-->
-request:
+<!--T:21-->
+Запрос:
+<!--T:22-->
 Request URL: [site]/api/profile/
-параметры запроса: (string) token
+<!--T:23-->
+Параметры запроса: (string) token
+<!--T:24-->
 Пример запроса:
 <pre>
@@ Строка 97: / Строка 138: @@
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (object)
-пример:
+Пример ответа (data):
 <pre>
 {
@@ Строка 119: / Строка 160: @@
 </pre>
-= Контроллеры =
+= Контроллеры = <!--T:25-->
-== Список Контроллеров Пользователя (list) ==
+== Список Контроллеров Пользователя (list) == <!--T:26-->
+<!--T:27-->
+Запрос:
-request:
 Request URL: [site]/api/ctrl/list/
-параметры запроса: (string) token
+<!--T:28-->
+Параметры запроса: (string) token
+<!--T:29-->
 Пример запроса:
@@ Строка 136: / Строка 181: @@
 </pre>
-response:
+<!--T:30-->
+Ответ:
-параметры ответа: (array)
-Пример ответа:
+<!--T:32-->
+Пример ответа (data):
 <pre>
 {
 "0":{
-	"id":"11",
+	"id": 651,
-	"name":"AS_A61301A020E4",
+	"name": "AE439648F951",
-	"armed":"0",   //0 - снят с охраны, 1 - под охраной
+	"ip": "192.168.10.135",
-	"device_ids":"a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}", //ids устройств на контроллере
+	"fw_id": "1",
-	"action_ids":"a:0:{}", //ids действий на контроллере
+	"hostname": "quadrobase",
-	"timezone":"3",
+	"armed": 0,
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"address": "",
-	"online":"1"
+	"lat": null,
-},
+	"lng": null,
-"1":{
+	"timezone": 2,
-	"id":"12",
+	"online": 1,
-	"name":"AS_A61301A020E5",
+	"last_online": "2019-06-17 19:36:48",
-	"armed":"1",
+	"type_signal": "wifi",
-	"device_ids":"a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}",
+	"wifi_param": -67,
-	"action_ids":"a:0:{}",
+	"gsm_param": 0,
-	"timezone":"2",
+	"phone": "",
-	"token":"734D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"pin": 0,
-	"online":"0"
+	"user_controller_name": "quadrobase",
+	"on_dashboard": 0
 }]
 </pre>
+== Информация о Контроллере (info) == <!--T:33-->
-== Информация о Контроллере (info) ==
+<!--T:34-->
+Запрос:
-request:
 Request URL: [site]/api/ctrl/info/
-параметры запроса: (int) controller_id , (string) token
+<!--T:35-->
+Параметры запроса:
+#(int) controller_id,
+#(string) token
+<!--T:36-->
 Пример запроса:
 <pre>
@@ Строка 181: / Строка 233: @@
 </pre>
-response:
+<!--T:37-->
+Ответ:
-параметры ответа: (object)
+<!--T:39-->
+Пример ответа (data):
-Пример ответа:
+<!--T:40-->
 <pre>
 {
 	"id":"6",
-	"name":"AS_7F26335CCF4B",
+	"name":"66D4E809EF0A",
-	"armed":"1",
+	"hostname":"Test Valera 34",
-	"device_ids":"a:26:{i:0;i:25;i:1;i:26;i:2;i:28;i:3;i:19;i:4;i:40;i:5;i:41;i:6;i:42;i:7;i:43;i:8;i:36;i:9;i:34;i:10;i:29;i:11;i:45;i:12;i:38;i:13;i:33;i:14;i:30;i:15;i:31;i:16;i:49;i:17;i:24;i:18;i:46;i:19;i:47;i:20;i:44;i:21;i:27;i:22;i:22;i:23;i:9;i:24;i:23;i:25;i:7;}",
+	"armed":0,
-	"action_ids":"a:4:{i:0;i:45;i:1;i:46;i:2;i:49;i:3;i:42;}",
+	"address":"",
-	"timezone":"3",
+	"lat":50.4156,
-	"token":"660D91C2B0926A8C981AE7DA4AAA4421A3D86D136262A6F8E98ACF534A7A715B",
+	"lng":30.5336,
-	"online":"1"
+	"ip":"192.168.1.155",
+	"fw_id":1,
+	"timezone":3,
+	"online":1,
+	"last_online":"2019-07-29 17:08:41",
+	"type_signal":"wifi",
+	"wifi_param":-78,
+	"gsm_param":0,
+	"phone":"",
+	"pin":0,
+	"user_controller_name":"Test Valera 34",
+	"on_dashboard":0
 }
 </pre>
-== Постановка/снятие Контроллера на охрану / с охраны  (armed) ==
+== Постановка/снятие Контроллера на охрану / с охраны  (armed) == <!--T:41-->
-request:
+<!--T:42-->
+Запрос:
+<!--T:43-->
 Request URL: [site]/api/ctrl/armed/
-параметры запроса: (int) controller_id , (string) token
+<!--T:44-->
-пример:
+Параметры запроса:
+№(int) controller_id,
+№(string) token
+Пример запроса:
+<!--T:45-->
 <pre>
 {
@@ Строка 215: / Строка 287: @@
 }
 </pre>
-так как MQTT  односторонний - ответа быть не может. Ответ что запрос ушел:
-response:
+Так как MQTT односторонний - ответа быть не может. Ответ что запрос ушел:
-параметры ответа:
-пример:
+Ответ:
+Пример ответа (data):
 <pre>
 {
@@ Строка 226: / Строка 300: @@
-== Добавление Контроллера (add) ==
+== Добавление Контроллера (add) == <!--T:46-->
-request:
+<!--T:47-->
+Запрос:
+<!--T:48-->
 Request URL: [site]/api/ctrl/add
-параметры запроса: (string) token
+<!--T:49-->
+Параметры запроса: (string) token
+<!--T:50-->
 Пример:
 <pre>
@@ Строка 240: / Строка 318: @@
 }
 </pre>
-response:
-параметры ответа:
+Ответ:
-пример:
+Пример ответа:
 <pre>
 {
@@ Строка 248: / Строка 327: @@
 }
 </pre>
 После ввода пин-кода необходимо обновить список Контроллеров (/api/ctrl/list/)
-== Обновление списка устройств и действий на Контроллере (update) ==
+== Обновление списка устройств и действий на Контроллере (update) == <!--T:51-->
-=== Этап 1 - обновляем список IDS устройств на Контроллере ===
+=== Этап 1 - обновляем список IDS устройств на Контроллере === <!--T:52-->
-request:
+Запрос:
+<!--T:53-->
 Request URL: [site]/api/ctrl/update/
-параметры запроса: (int) controller_id , (string) token
-пример:
+Параметры запроса:
+#(int) controller_id,
+#(string) token
+Пример запроса:
 <pre>
 {
@@ Строка 264: / Строка 350: @@
 }
 </pre>
-response:
-параметры ответа:
+Ответ:
-пример:
+Пример ответа (data):
 <pre>
 {
-	"result": "Ok" // "Ok" = запрос ушел
+	"result": "Ok" // "Ok" = запрос отправлен
 }
 </pre>
-=== Этап 2 - обновляем информацию о каждом устройстве ===
+=== Этап 2 - обновляем информацию о каждом устройстве === <!--T:54-->
+<!--T:55-->
+Запрос:
-request:
 Request URL: [site]/api/ctrl/update-devices/
-параметры запроса:
+<!--T:56-->
+Параметры запроса:
-(int) controller_id,
+<!--T:57-->
-(string) token
+#(int) controller_id,
+#(string) token
+<!--T:58-->
 Пример запроса:
 <pre>
@@ Строка 291: / Строка 383: @@
 </pre>
-response:
+<!--T:59-->
+Ответ:
-параметры ответа:
+<!--T:61-->
+Пример ответа:
-Пример ответа:
 <pre>
 {
-	"result": "Ok" // ответ что запрос ушел
+	"result": "Ok" // Запрос отправлен
 }
 </pre>
 Процесс происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (контроллер, устройства)
-== Удаление Контроллера (delete) ==
+== Удаление Контроллера (delete) == <!--T:62-->
+Запрос:
+<!--T:63-->
 Request URL: [site]/api/ctrl/delete
-Параметры запроса:
+<!--T:65-->
 Пример запроса:
@@ Строка 319: / Строка 415: @@
 </pre>
-response:
+<!--T:66-->
-параметры ответа:
+Ответ:
-пример:
+Пример ответа:
 <pre>
 {
 	"error":null,
-	"data":{"resuls":"Ok"}
+	"data":{"result":"Ok"}
 }
 </pre>
-== Обновление статуса контроллера (update-status) ==
+== Обновление статуса контроллера (update-status) == <!--T:67-->
-request:
+<!--T:68-->
+Запрос:
-Request URL: [site]/api/ ctrl/update-status/
+<!--T:69-->
+Request URL: [site]/api/ctrl/update-status/
+<!--T:70-->
 Параметры запроса:
-(string) token,
+#(string) token,
+#(int) controller_id
-(int) controller_id
+<!--T:73-->
+Пример запроса:
-Пример запроса:
 <pre>
 {
@@ Строка 349: / Строка 451: @@
 </pre>
-response:
+<!--T:74-->
+Ответ:
-параметры ответа:
+<!--T:76-->
+Пример ответа:
-Пример ответа:
 <pre>
 {
 	"error":null,
 	"data":{
-		"resuls":"Ok"
+		"result":"Ok"
 		}
 }
 </pre>
-== Получение актуального статуса Контроллера (get-status) ==
+== Получение актуального статуса Контроллера (get-status) ==  <!--T:77-->
-request:
-Request URL: [site]/api/ ctrl/get-status/
+Запрос:
-параметры запроса:
+<!--T:78-->
+Request URL: [site]/api/ctrl/get-status/
-(string) token,
+<!--T:79-->
+Параметры запроса:
-(int) controller_id
+#(string) token,
+#(int) controller_id
+<!--T:82-->
 Пример запроса:
 <pre>
 {
@@ Строка 382: / Строка 489: @@
 </pre>
-response:
+<!--T:83-->
+Ответ:
-параметры ответа:
+<!--T:85-->
+Пример ответа:
-Пример ответа:
 <pre>
 {
@@ Строка 396: / Строка 504: @@
 </pre>
+<!--T:86-->
 Поле “status” может принимать следующие значения:
 • 0 – офлайн
+<!--T:87-->
 • 1 – онлайн
+<!--T:88-->
 • 2 – онлайн, после включения питания
-= Устройства =
+== Получение конфигурации Контроллера (config) == <!--T:89-->
-== Получение списка устройств пользователя (list) ==
+<!--T:82-->
+Запрос:
-request:
+Request URL: [site]/api/ctrl/config/
-Request URL: [site]/api/device/list
+<!--T:82-->
+Параметры запроса:
+#(string) token,
+#(int) controller_id
-параметры запроса: (int) controller_id , (string) token
+<!--T:82-->
+Пример запроса:
-Пример запроса:
 <pre>
 {
-	"controller_id": 1 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"controller_id" : 111
 }
 </pre>
-response:
+<!--T:82-->
-параметры ответа:
+Ответ:
-Пример ответа:
+<!--T:82-->
+Пример ответа (data):
 <pre>
 {
-"0":{
+	"id":"1",   // id конфигурации
-	"id":"122",
+	"controller_id":"111",   // id контроллера
-	"external_id":"19", //id на контроллере
+	"language":"ru-RU",
-	"controller_id":"6",
+	"hostname":"alarm-system",
-	"name":"Сирена",
+	"wifi_mode":1,   // 1 - STA, 2 - AP
-	"type_id":"2",  //тип устройства
+	"wifi_sta_type":1, // 0 - STATIC, 1 - DHCP
-	"codes":":{     //коды (кнопки)
+	"wifi_sta_ssid":"SSID",
-		"0":{
+	"wifi_sta_pass":"PASSWORD",
-		"id":"218",
+	"wifi_sta_ip":"192.168.0.101",
-		"external_cod_id":"32",
+	"wifi_sta_mask":"255.255.255.0",
-		"device_id":"122",
+	"wifi_sta_gw":"192.168.0.1",
-		"name":"ON",
+	"wifi_sta_dns1":"208.67.222.222",
-		"code":"3675192",
+	"wifi_sta_dns2":"208.67.222.222",
-		"protocol":"1",
+	"wifi_ap_authmode": 3, // 0 - OPEN, 1 - WEP, 2 - WPA_PSK, 3 - WPA2_PSK, 4 - WPA_WPA2_PSK
-		"pulse_len":null,
+	"wifi_ap_hidden":0, // 0/1
-		"group_1":"1",
+	"wifi_ap_channel":1, // 1...14
-		"group_2":"0",
+	"wifi_ap_ssid":"SMARTHOME_000000000000",
-		"group_3":"0",
+	"wifi_ap_pass":"00000000",
-		"group_4":"0",
+	"wifi_ap_ip":"192.168.4.1",
-		"group_5":"0",
+	"wifi_ap_mask":"255.255.255.0",
-		"group_6":"0",
+	"wifi_ap_gw":"192.168.4.1",
-		"group_7":"0",
+	"httpd_port":80, // 1...65535
-		"group_8":"0",
+	"httpd_auth":0, // 0/1
-		"active":"1"
+	"httpd_user":"admin",
-		},
+	"httpd_pass":"admin",
-		"1":{ ... }
+	"ntp_enable":0, // 0/1
-	},
+	"ntp_host":"time.windows.com",
-	"state":"1",
+	"ntp_tz":3, // -11...13
-	"on_dashboard":"1", //показывать на главной
+	"upnp_enable":1, // 0/1
-	"active":"1"
+	"advanced_mode":0, // 0/1
-},
+	"app_afb_enable":1, // 0/1
-"1":{
+	"app_leds_off":1, // 0/1
-	"id":"120",
+	"app_alarm_duration":10, // minutes
-	"external_id":"22",
+	"app_arming_delay":0, // seconds
-	"controller_id":"6",
+	"app_portal_link":0, // 0/1
-	"name":"Пульт 4кн бел",
+	"app_rf_freq":2, // 1 - 315Mhz, 2 - 433Mhz
-	"type_id":"3",
+	"app_rf_power":3, // 0 - 1DBM, 1 - 2DBM, 2 - 5DBM, 3 - 8DBM, 4 - 11DBM, 5 - 14DBM, 6 - 17DBM, 7 - 20DBM
-	"codes": ... ,
+	"app_button_action":1, // 0 - NONE, 1 - ARMING, 2 - RUN_ACTION, 3 - SEND_CODE
-	"state":"1",
+	"app_button_rec_id":0, // ID
-	"on_dashboard":"0",
+	"gsm_pin":"1234",
-	"active":"1"
+	"gsm_allowed_phones":"", // список через запятую
-}
+	"gsm_sendto_phones":"", // список через запятую
-}
+	"gsm_callto_phones":"", // один номер
-</pre>
+	"gsm_smsin_enable":"0", // 0/1
+	"gsm_smsout_enable":"0", // 0/1
+	"gsm_call_enable":"0", // 0/1
+	"gprs_enable":"1", // 0/1
+	"gprs_apn":"", "internet.mts.ru",
+	"gprs_user":"mts",
+	"gprs_pass":"mts",
+	"gsm_enable":"0", // 0/1
+	"ebus_enable":0, // 0/1
+	"command":"xxx",
+	"response":"0"
+}
+</pre>
+== Изменение конфигурации контроллера(config-set) == <!--T:89-->
+<!--T:89-->
+Запрос:
+Request URL: [site]/api/ctrl/config-set/
+<!--T:89-->
+Параметры запроса:
+#(string) token,
+#(int) controller_id
+<!--T:89-->
+Пример запроса:
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id" : 111,
+	"command": "yyy"    // параметры контроллера смотри метод Получить конфигурацию контроллера(ctrl/config/)
+}
+</pre>
+<!--T:89-->
+Ответ:
+<!--T:89-->
+Пример ответа (data):
+<pre>
+{
+	"result": "Ok"
+}
+</pre>
+==  Передача локального IP Контроллера (get-ip) == <!--T:89-->
+Запрос
+<!--T:90-->
+Request URL: [site]/api/ctrl/get-ip
-== Информация об устройстве (info) ==
+<!--T:91-->
+Request Params:
-request:
+#token (required): string(64);
+#controller_id (required): int;
-Request URL: [site]/api/device/info/
+Ответ:
+<!--T:94-->
-параметры запроса:
+Пример ответа:
-(int) controller_id,
+<!--T:95-->
+<pre>
+{
+	data:'192.168.0.15',
+	error: null
+}
+</pre>
-(int) device_id,
+== Установка подписки на Контроллере == <!--T:96-->
-(string) token
+Запрос:
+<!--T:97-->
+Request URL: [site]/in/subscription/set”
+Ответ:
+Пример ответа (data):
-Пример запроса:
 <pre>
 {
-	"controller_id": 1 ,
+	"seq_id": 0,
-	"device_id": 122,
+	"id": 1, // ID подписки (см. ниже)
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
 }
 </pre>
-response:
+==  Просмотр статуса подписки (get-subscribe-status) == <!--T:98-->
+Запрос:
+<!--T:99-->
+Request URL: [site]/api/ctrl/get-subscribe-status
+<!--T:100-->
+Параметры:
+<!--T:101-->
+#token (required): string(64)
+#controller_id (required): int
+<!--T:103-->
+Ответ:
+Пример ответа (data):
-параметры ответа:
+<!--T:104-->
-Пример ответа:
 <pre>
 {
-	"id":"122",
+	data:{
-	"external_id":"19",
+		id: 1,
-	"controller_id":"6",
+		controller_id: 40,
-	"name":"Сирена",
+		user_id: 424,
-	"type_id":"2",
+		remain_time: 100,
-	"codes":{
+		request_time: 1355314332,
-		"0":{
+		response_time: 1355315332,
-		"id":"218",
+		success: 0
-		"external_cod_id":"32",
-		"device_id":"122",
-		"name":"ON",
-		"code":"3675192",
-		"protocol":"1",
-		"pulse_len":null,
-		"group_1":"1",
-		"group_2":"0",
-		"group_3":"0",
-		"group_4":"0",
-		"group_5":"0",
-		"group_6":"0",
-		"group_7":"0",
-		"group_8":"0",
-		"active":"1"
-		},
-		"1":{
-		"id":"219",
-		"external_cod_id":"33",
-		"device_id":"122",
-		"name":"OFF",
-		"code":"3675186
-		...
-		}
 	},
-	"state":"1",
+	error: ''
-	"on_dashboard":"1",
-	"active":"1"
 }
 </pre>
+==  Активация/продление/покупка подписки (set-subscribe) == <!--T:105-->
-== Обновление информации об устройстве (update) ==
+Запрос:
-request:
+<!--T:106-->
+Request URL: [site]/api/ctrl/set-subscribe
-Request URL: [site]/api/device/update/
-параметры запроса:
-(int) device_id,
+<!--T:107-->
+Параметры:
-(string) name,
+<!--T:108-->
+#token (required): string(64)
+#controller_id (required): int
-(int) active,
+<!--T:110-->
+Ответ:
-(string) token,
-Пример запроса:
 <pre>
 {
-	"device_id": 107,   // local device id
+	data:{
-	"name": "New name", // new name
+		id: 1,
-	"active": 1,
+		controller_id: 40,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+		user_id: 424,
+		remain_time: 100,
+		request_time: 1355314332,
+		response_time: 1355315332,
+		success: 0
+	},
+	error: ''
 }
 </pre>
-response:
-параметры ответа:
+==  Метод получения списка телефонов (get-phones) == <!--T:111-->
-Пример ответа:
+Запрос:
-<pre>
-{
+<!--T:112-->
-	"resuls" : "Ok"
+Request URL: [site]/api/ctrl/get-phones
-}
-</pre>
-== Удаление устройства (delete) ==
+<!--T:113-->
+Параметры:
-request:
+<!--T:114-->
+#token (required): string, 64
+#controller_id (required): int
+#type (optional): string,
+#range ['recipient', 'authorized', 'all'], (default: 'all')
-Request URL: [site]/api/device/delete/
+<!--T:117-->
+Ответ:
-параметры запроса:
+Пример ответа:
-(int) device_id,
+<!--T:118-->
-(string) token
-Пример запроса:
 <pre>
 {
-	"device_id": 107,   // local device id
+	'error': null,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	data: [
+		{'id': 5, 'phone': '+380123456789'},
+		{'id': 6, 'phone': '+380123334455'},
+		{'id': 7, 'phone': '+380112223344'}
+	]
 }
 </pre>
-response:
-Параметры ответа:
+==  Редактирование телефона (edit-phone) == <!--T:119-->
-Пример ответа:
+Запрос:
-<pre>
-{
-	"resuls" : "Ok"
-}
+<!--T:120-->
-</pre>
+Request URL: [site]/api/ctrl/edit-phone
+<!--T:121-->
+Параметры:
-== Получение метеоданных (last) ==
+<!--T:122-->
+#token (required): string, 64
+#phone_id (required): int
+#is_recipient (optional): int
+#is_authorized (optional): int
+#phone (optional): string
-request:
+<!--T:127-->
-Request URL: [site]/api/device/meteo-last/
+Ответ:
-параметры запроса:
+Пример ответа:
+<pre>
+{
+	"error":null,
+	"data":{
+		"id":2,
+		"controller_id":81,
+		"phone":"+380503334455",
+		"is_recipient":"1",
+		"is_authorized":0
+	}
+}
+</pre>
-(string) token,
-(int) device_id
+==  Удаление телефона (delete-phone) == <!--T:128-->
+Запрос:
+<!--T:129-->
+Request URL: [site]/api/ctrl/delete-phone
+<!--T:130-->
+Параметры:
+<!--T:131-->
+#token (required): string, 64
+#phone_id (required): int
+<!--T:133-->
+Ответ:
+Пример ответа:
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"error":null,
-	"device_id": 130
+	"data":{"response":"OK"}
 }
 </pre>
-response:
-параметры ответа: (object)
+== Добавление телефона (add-phone) == <!--T:134-->
-Пример ответа:
+Запрос:
+<!--T:135-->
+Request URL: [site]/api/ctrl/add-phone
+<!--T:136-->
+Params:
+<!--T:137-->
+#token (required): string, 64
+#controller_id (required): int
+#phone (required): string
+#is_recipient (optional): int
+#is_authorized (optional): int
+<!--T:142-->
+Ответ:
+Пример ответа:
+<!--T:143-->
 <pre>
 {
-	"id":"4046",
+	"error":null,
-	"controller_name":"AS_7FD6785CCF5D",
+	"data":{
-	"internal_id":"55",
+		"id":2,
-	"device_id":"130",
+		"controller_id":81,
-	"name":"7",
+		"phone":"+380503334455",
-	"temp":"240",
+		"is_recipient":"1",
-	"hum":"245",
+		"is_authorized":0
-	"illum":"0",
+	}
-	"pres":"1239",
-	"volt":"32",
-	"date_time":"2016-03-02 21:09:40",
-	"new":"0"
 }
 </pre>
-== Получение метеоданных за период (period) ==
+== Информация о версии прошивки контроллера (fw-version-current) == <!--T:145-->
-request:
-Request URL: [site]/api/device/meteo-period/
+Запрос:
-параметры запроса:
+Request URL: [site]/api/ctrl/fw-version-current/
-(string) token,
+Параметры запроса:
-(int) device_id,
+#(int) controller_id,
+#(string) token
-(int) period
+Пример запроса:
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id": 1 ,
-	"device_id": 130,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-	"period": 1 // количество дней
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (array to objects)
+Пример ответа (data):
-Пример ответа:
 <pre>
-[
+{
-	{
+	"version_id":1,
-	"id":"4065",
+	"version_name":"0.01",
-	"controller_name":"AS_7FD6785CCF5D",
+	"tag":"OLD",
-	"internal_id":"55",
+	"url":"\/controllers_fw\/NULL.bin",
-	"device_id":"130",
+	"date":"16.10.2018",
-	"name":"7",
+	"new_version_id":38   // если "new_version_id" != "version_id" значит имеется новая версия.
-	"temp":"240",
+}
-	"hum":"523",
+</pre>
-	"illum":"0",
-	"pres":"1239",
-	"volt":"32",
+== Информация о последней версии прошивки контроллера (get-new-fw-version) == <!--T:145-->
-	"date_time":"2017-07-30 21:11:07",
-	"new":"0"
+Запрос:
-	},
-	{
+Request URL: [site]/api/ctrl/get-new-fw-version/
-	"id":"4067",
-	"controller_name":"AS_7FD6785CCF5D
+Параметры запроса:
-	...
-	},
+#(int) controller_id,
-]
+#(string) token
-</pre>
-== Получение данных электропитания (last) ==
+<pre>
+Пример запроса:
-request:
-Request URL: [site]/api/device/electro-last/
-параметры запроса:
+{
+	"controller_id": 1 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+}
+</pre>
-(string) token,
+Ответ:
-(int) device_id
+Пример ответа (data):
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"version_id":38,
-	"device_id": 130
+	"version_name":"0.14",
+	"tag":"0.14 \/ Oct 5 2018 16:49:04",
+	"url":"\/controllers_fw\/tls-smarthome-hw-9_0.14.bin",
+	"date":"16.10.2018"
 }
 </pre>
-response:
+= Устройства = <!--T:144-->
-параметры ответа: (object)
+== Получение списка устройств пользователя (list) == <!--T:145-->
-Пример ответа:
+<!--T:146-->
+Запрос:
-<pre>
+<!--T:147-->
-{
+Request URL: [site]/api/device/list
-	"id":"318",
-	"controller_id":"11",
-	"external_id":"2",
-	"device_id":"125",
-	"name":"23",
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
-	"last_seen":"2017-07-21 04:20:27",
-	"available":"1",
-	"voltage":"24",
-	"have_voltage":"1",
-	"current":"2147483647",
-	"have_current":"1",
-	"supp_voltage":"33",
-	"date_create":"2017-07-21 01:20:33",
-	"new":"0"
-}
-</pre>
-== Получение данных электропитания за период (period) ==
+<!--T:148-->
+Параметры запроса:
-request:
-Request URL: [site]/api/device/electro-period/
-параметры запроса:
-(string) token,
+#(int) controller_id,
+#(string) token
-(int) device_id,
-(int) period
+<!--T:149-->
 Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id": 1 ,
-	"device_id": 130,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-	"period": 1 // количество дней
 }
 </pre>
-response:
-параметры ответа: (array to objects)
+<!--T:150-->
+Ответ:
-Пример ответа:
+Пример ответа (data):
 <pre>
-[
+{
-	{
+"0":{
-	"id":"318",
+	"id":"122",
-	"controller_id":"11",
+	"external_id":"19", //id на контроллере
-	"external_id":"2",
+	"controller_id":"6",
-	"device_id":"125",
+	"name":"Сирена",
-	"name":"23",
+	"type_id":"2",  //тип устройства
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"codes":":{     //коды (кнопки)
-	"last_seen":"2017-07-21 04:20:27",
+		"0":{
-	"available":"1",
+		"id":"218",
-	"voltage":"24",
+		"external_cod_id":"32",
-	"have_voltage":"1",
+		"device_id":"122",
-	"current":"2147483647",
+		"name":"ON",
-	"have_current":"1",
+		"code":"3675192",
-	"supp_voltage":"33",
+		"protocol":"1",
-	"date_create":"2017-07-21 01:20:33",
+		"pulse_len":null,
-	"new":"0"
+		"group_1":"1",
+		"group_2":"0",
+		"group_3":"0",
+		"group_4":"0",
+		"group_5":"0",
+		"group_6":"0",
+		"group_7":"0",
+		"group_8":"0",
+		"active":"1"
+		},
+		"1":{ ... }
 	},
-	{
+	"state":"1",
-	"id":"318",
+	"on_dashboard":"1", //показывать на главной
-	"controller_id":"11",
+	"active":"1"
-	...
+},
-	},
+"1":{
-]
+	"id":"120",
-</pre>
+	"external_id":"22",
+	"controller_id":"6",
+	"name":"Пульт 4кн бел",
+	"type_id":"3",
+	"codes": ... ,
+	"state":"1",
+	"on_dashboard":"0",
+	"active":"1"
+	}
+}
+</pre>
-== Получение данных о сторонних устройствах (other-last) ==
+== Информация об устройстве (info) == <!--T:151-->
-Метод возвращает информацию о последнем обнаруженном стороннем устройстве.
+<!--T:152-->
+Запрос:
-request:
-Request URL: [site]/api/device/other-last/
+<!--T:153-->
+Request URL: [site]/api/device/info/
+<!--T:154-->
 Параметры запроса:
-(string) token,
+<!--T:155-->
+#(int) controller_id,
-(int) device_id
+#(int) device_id,
+#(string) token
+<!--T:158-->
 Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id": 1 ,
-	"device_id": 118
+	"device_id": 122,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа: (object)
+<!--T:159-->
+Ответ:
-Пример ответа:
+Пример ответа (data):
 <pre>
 {
-	"id":"1301",
+	"id":"122",
+	"external_id":"19",
 	"controller_id":"6",
-	"device_id":"118",
+	"name":"Сирена",
-	"name":"Розетка",
+	"type_id":"2",
-	"code":"81",
+	"codes"
-	"pulse_len":null,
+		"0"
-	"bit_len":null,
+			"id":"218",
-	"protocol":null,
+			"external_cod_id":"32",
-	"groups":null,
+			"device_id":"122",
-	"type":null,
+			"name":"ON",
-	"date_time":"2017-08-21 04:55:18",
+			"code":"3675192",
-	"active":null,
+			"protocol":"1",
-	"new":"1"
+			"pulse_len":null,
+			"group_1":"1",
+			"group_2":"0",
+			"group_3":"0",
+			"group_4":"0",
+			"group_5":"0",
+			"group_6":"0",
+			"group_7":"0",
+			"group_8":"0",
+			"active":"1",
+		},
+		"1"
+			"id":"219",
+			"external_cod_id":"33",
+			"device_id":"122",
+			"name":"OFF",
+			"code":"3675186
+		...
+		}
+	},
+	"state":"1",
+	"on_dashboard":"1",
+	"active":"1",
+	"alias":"xxx",
+	"send_sms ":0,
+	"voice_call":0,
+	place"
+		"name":null,
+		"color":null
+		}
 }
 </pre>
+== Обновление информации об устройстве (update) == <!--T:161-->
-== Получение данных о сторонних устройствах за период (other-period) ==
+<!--T:162-->
-request:
+Запрос:
-Request URL: [site]/api/device/other-period/
+<!--T:163-->
+Request URL: [site]/api/device/update/
-параметры запроса:
+<!--T:164-->
+Параметры запроса:
-(string) token,
+<!--T:165-->
+#(int) device_id,
+#(string) name,
+#(int) active,
+#(string) token,
-(int) device_id,
+<!--T:169-->
+Пример запроса (data):
+<pre>
+{
+	"device_id": 107,   // local device id
+	"name": "New name", // new name
+	"active": 1,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+}
+</pre>
-(int) period
+Ответ:
+Пример ответа (data):
-Пример запроса:
+<pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"result" : "Ok"
-	"device_id": 118,
-	"period": 1 // количество дней
 }
-response:
+</pre>
+== Удаление устройства (delete) == <!--T:171-->
-параметры ответа: (array to objects)
+<!--T:172-->
+Запрос:
-Пример ответа:
+<!--T:173-->
-<pre>
+Request URL: [site]/api/device/delete/
-{
-	"id":"1301",
-	"controller_id":"6",
-	"device_id":"118",
-	"name":"Розетка",
-	"code":"81",
-	"pulse_len":null,
-	"bit_len":null,
-	"protocol":null,
-	"groups":null,
-	"type":null,
-	"date_time":"2017-08-21 04:55:18",
-	"active":null,
-	"new":"1"
-	},
-	{
-	"id":"4067",
-	"controller_id":"6",
-	...
-}
-</pre>
-= Wizard добавления устройств  =
+<!--T:174-->
+Параметры запроса:
+<!--T:175-->
+#(int) device_id,
+#(string) token
-== Датчик открытия двери (create-door-open-sensor) ==
+<!--T:177-->
+Пример запроса:
-URL:  [site]/api/wizard/create-door-open-sensor
-Params:
-controller_id (required): int
-token (required): string, 64
-device_name (optional): string, 256
-code_ready (optional): string, 64 //Название кода готовности
-code_alarm (optional): string, 64 //Название кода оповещания
-code_low_battery (optional): string, 64 //Название кода садящейся батареи
-RESPONSE:
 <pre>
 {
-	data:{
+	"device_id": 107,   // local device id
-		'response': 'OK'
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-		},
+}
-	error: null
-}
 </pre>
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+<!--T:178-->
+Ответ:
+<!--T:180-->
+Пример ответа (data):
-==  Датчик затопления (create-flood-sensor) ==
+<pre>
+{
+	"result" : "Ok"
+}
+</pre>
-Request URL: [site]/api/wizard/create-flood-sensor
+== Получение метеоданных (last) == <!--T:182-->
-Params:
+<!--T:183-->
+Запрос:
-controller_id (required): int
+Request URL: [site]/api/device/meteo-last/
-token (required): string, 64
+<!--T:184-->
+Параметры запроса:
-device_name (optional): string, 256
+<!--T:185-->
-code_alarm (optional): string, 64 //Название кода оповещения
+#(string) token,
+#(int) device_id
-code_tamper (optional): string, 64 //Название кода вмешательства
+<!--T:187-->
+Пример запроса:
-code_low_battery (optional): string, 64 //Название кода садящейся батареи
-RESPONSE:
 <pre>
 {
-	data: {
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		'response': 'OK'
+	"device_id": 130
-		},
-	error: null
 }
 </pre>
----------------------------------------
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+Ответ:
-== Пульт,4 кнопки (create-console) ==
+<!--T:189-->
+Пример ответа (data):
-Request URL: [site]/api/wizard/create-console
+<!--T:190-->
+<pre>
-Params:
+{
+	"id":"4046",
+	"controller_name":"AS_7FD6785CCF5D",
+	"internal_id":"55",
+	"device_id":"130",
+	"name":"7",
+	"temp":"240",
+	"hum":"245",
+	"illum":"0",
+	"pres":"1239",
+	"volt":"32",
+	"date_time":"2016-03-02 21:09:40",
+	"new":"0"
+}
+</pre>
-controller_id (required): int
+== Получение метеоданных за период (period) == <!--T:191-->
-token (required): string, 64
+Запрос:
-device_name (optional): string, 256
+<!--T:192-->
+Request URL: [site]/api/device/meteo-period/
-code_lock (optional): string, 64 //Название кода блокировки
+<!--T:193-->
+Параметры запроса:
-code_unlock (optional): string, 64 //Название кода разблокировки
+<!--T:194-->
+#(string) token,
+(int) device_id,
+#(int) period
-code_s (optional): string, 64 //Название кода s
+<!--T:197-->
+Пример запроса:
-code_alarm (optional): string, 64 //Название кода оповещения
-RESPONSE:
 <pre>
 {
-	data: {
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		'response': 'OK'
+	"device_id": 130,
-	},
+	"period": 1 // количество дней
-	error: null
 }
 </pre>
----------------------------------------
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+<!--T:198-->
+Ответ:
-== Сирена (create-siren) ==
+<!--T:199-->
+параметры ответа (array to objects):
-Request URL: [site]/api/wizard/create-siren
+<!--T:200-->
+Пример ответа (data):
-Params:
+<pre>
+[
+	{
+	"id":"4065",
+	"controller_name":"AS_7FD6785CCF5D",
+	"internal_id":"55",
+	"device_id":"130",
+	"name":"7",
+	"temp":"240",
+	"hum":"523",
+	"illum":"0",
+	"pres":"1239",
+	"volt":"32",
+	"date_time":"2017-07-30 21:11:07",
+	"new":"0"
+	},
+	{
+	"id":"4067",
+	"controller_name":"AS_7FD6785CCF5D
+	...
+	},
+]
+</pre>
-controller_id (required): int
+== Получение данных электропитания (last) == <!--T:201-->
+Запрос:
-token (required): string, 64
+Request URL: [site]/api/device/electro-last/
-device_name (optional): string, 256
+<!--T:202-->
+Параметры запроса:
-code_on (optional): string, 64 //Название кода включения
+<!--T:203-->
+#(string) token,
+#(int) device_id
-code_off (optional): string, 64 //Название кода выключения
+<!--T:205-->
+Пример запроса:
-code_blank (optional): string, 64 //Название кода blank
-RESPONSE:
 <pre>
 {
-	data: {
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		'response': 'OK'
+	"device_id": 130
-		},
-	error: null
 }
 </pre>
----------------------------------------
-Перед отправкой параметров необходимо перевести сирену в режим обучения.
+<!--T:206-->
+Ответ:
-== Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos) ==
+<!--T:208-->
-Request URL: [site]/api/wizard/get-meteos
+Пример ответа (data):
-Params:
+<!--T:209-->
-controller_id (required): int
-token (required): string, 64
-RESPONSE:
 <pre>
 {
-	"error":null,
+	"id":"318",
-	"data":				 	[{"id":"93","controller_id":"79","date":"1528389351","type":"7","family":"0","rf_code":null,"rf_bit_len":null,"rf_pulse_len":null,"rf_protocol":null,"rf_freq":null,"ir_code":null,"ir_bit_len":null,"ir_address":null,"ir_protocol":null,"meteo_num":"0"}]
+	"controller_id":"11",
-}
+	"external_id":"2",
-</pre>
+	"device_id":"125",
+	"name":"23",
-== Метеостанция: добавление (create-meteo) ==
+	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"last_seen":"2017-07-21 04:20:27",
-Request URL: [site][site]/api/wizard/create-meteo
+	"available":"1",
+	"voltage":"24",
+	"have_voltage":"1",
+	"current":"2147483647",
+	"have_current":"1",
+	"supp_voltage":"33",
+	"date_create":"2017-07-21 01:20:33",
+	"new":"0"
+}
+</pre>
-Params:
+== Получение данных электропитания за период (period) == <!--T:210-->
+Запрос:
-controller_id (required): int
+<!--T:211-->
+Request URL: [site]/api/device/electro-period/
-token (required): string, 64
+<!--T:212-->
+Параметры запроса:
-meteo_num (required): int //Получается в списке выше
+<!--T:213-->
+#(string) token,
+#(int) device_id,
+#(int) period
-device_name (optional): string, 256
+<!--T:216-->
+Пример запроса:
-RESPONSE:
 <pre>
 {
-	"error":null,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"data":{
+	"device_id": 130,
-		"response":"OK"
+	"period": 1 // количество дней
-		}
 }
 </pre>
+Ответ:
+<!--T:217-->
+Параметры ответа: (array to objects)
-== Водопроводный кран ==
+<!--T:218-->
+Пример ответа (data):
-Порядок добавления крана:
-) Сгенерировать коды
+<pre>
+[
+	{
+	"id":"318",
+	"controller_id":"11",
+	"external_id":"2",
+	"device_id":"125",
+	"name":"23",
+	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"last_seen":"2017-07-21 04:20:27",
+	"available":"1",
+	"voltage":"24",
+	"have_voltage":"1",
+	"current":"2147483647",
+	"have_current":"1",
+	"supp_voltage":"33",
+	"date_create":"2017-07-21 01:20:33",
+	"new":"0"
+	},
+	{
+	"id":"318",
+	"controller_id":"11",
+	...
+	},
+]
+</pre>
-) Зажать на кране кнопку, пока кран не мигнёт трижды
+== Получение данных о сторонних устройствах (other-last) == <!--T:219-->
-) Отправить один код
+<!--T:220-->
+Метод возвращает информацию о последнем обнаруженном стороннем устройстве.
+Запрос:
-) Нажать на кране кнопку однократно
+<!--T:221-->
+Request URL: [site]/api/device/other-last/
-) Зажать на кране кнопку, пока не мигнёт 4 раза
+<!--T:222-->
+Параметры запроса:
-) Отправить второй код из сгенерированных
-) Нажать на кране кнопку однократно
+<!--T:223-->
+#(string) token,
+#(int) device_id
-) Отправить запрос на создание крана.
+<!--T:225-->
+Пример запроса:
-=== Генерация кодов ===
-Request URL: [site]/api/wizard/create-codes
-Params:
-controller_id (required): int
-token (required): string, 64
-Response:
 <pre>
 {
-	"error":null,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"data":{"response":{"id":30,"masks":"[6,4,0,1]","code_1":"9920950","code_2":"9920948","code_3":"9920944","code_4":"9920945"}
+	"device_id": 118
-		}
 }
 </pre>
+Ответ:
-=== Выполнение кода ===
+<!--T:227-->
+Пример ответа (data):
-Request URL: [site]/api/wizard/execute-code
+<pre>
+{
-Params:
+	"id":"1301",
+	"controller_id":"6",
-controller_id (required): int
+	"device_id":"118",
+	"name":"Розетка",
-token (required): string, 64
+	"code":"81",
+	"pulse_len":null,
-code (required): int // Берется из сгенерированных
+	"bit_len":null,
+	"protocol":null,
-Response:
+	"groups":null,
-<pre>
+	"type":null,
-{
+	"date_time":"2017-08-21 04:55:18",
-	error: null,
+	"active":null,
-	data: {
+	"new":"1"
-		"response":"OK"
-		}
 }
 </pre>
-=== Добавление крана ===
-Request URL: [site]/api/wizard/create-crane-by-codes
+== Получение данных о сторонних устройствах за период (other-period) == <!--T:228-->
-Params:
+Запрос:
-controller_id (required): int
+<!--T:229-->
+Request URL: [site]/api/device/other-period/
-token (required): string, 64
+<!--T:230-->
+Параметры запроса:
-code_1 (required): int
+<!--T:231-->
+#(string) token,
+#(int) device_id,
+#(int) period
-code_2 (required): int
+<!--T:234-->
+Пример запроса:
-device_name (optional): string, 256
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"device_id": 118,
+	"period": 1 // количество дней
+}
+</pre>
-code_open (optional): string, 64 //Название кода открытия
+Ответ:
-code_close (optional): string, 64 //Название кода закрытия
+<!--T:236-->
+Пример ответа (data):
-RESPONSE:
 <pre>
 {
-	data:{'response': 'OK'},
+	"id":"1301",
-	error: null
+	"controller_id":"6",
+	"device_id":"118",
+	"name":"Розетка",
+	"code":"81",
+	"pulse_len":null,
+	"bit_len":null,
+	"protocol":null,
+	"groups":null,
+	"type":null,
+	"date_time":"2017-08-21 04:55:18",
+	"active":null,
+	"new":"1"
+	},
+	{
+	"id":"4067",
+	"controller_id":"6",
+	...
 }
 </pre>
-== Добавление розетки ==
+= Wizard добавления устройств  = <!--T:237-->
-порядок добаления розетки следующий:
-) Сгенерировать коды
+== Датчик открытия двери (create-door-open-sensor) == <!--T:238-->
-) Зажать на розетке кнопку, пока она не начнет мигать
+Запрос:
+<!--T:239-->
+URL:  [site]/api/wizard/create-door-open-sensor
-) Отправить один код
+<!--T:240-->
+Параметры запроса:
-) Зажать на розетке кнопку, пока она не начнет мигать
+#controller_id (required): int
+#token (required): string, 64
+#device_name (optional): string, 256
+#code_ready (optional): string, 64 //Название кода готовности
+#code_alarm (optional): string, 64 //Название кода оповещания
+#code_low_battery (optional): string, 64 //Название кода садящейся батареи
-) Отправить второй код из сгенерированых
+<!--T:241-->
+Ответ:
-) Отправить запрос на создание розетки
+Пример ответа:
+<pre>
+{
+	data:{
+		'response': 'OK'
+		},
+	error: null
+}
+</pre>
+<!--T:242-->
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-=== Генерация кодов (create-codes) ===
+==  Датчик затопления (create-flood-sensor) == <!--T:243-->
-Request URL: [site]/api/wizard/create-codes
+Запрос:
-Params:
+<!--T:244-->
+Request URL: [site]/api/wizard/create-flood-sensor
-controller_id (required): int
+<!--T:245-->
+Параметры запроса:
-token (required): string, 64
+<!--T:246-->
+#controller_id (required): int
+#token (required): string, 64
+#device_name (optional): string, 256
+#code_alarm (optional): string, 64 //Название кода оповещения
+#code_tamper (optional): string, 64 //Название кода вмешательства
+#code_low_battery (optional): string, 64 //Название кода садящейся батареи
-socket (required): любое значение.
+<!--T:251-->
+Ответ:
-Response:
+Пример ответа:
 <pre>
 {
-	"error":null,
+	data: {
-	"data":{
+		'response': 'OK'
-		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
+		},
-		}
+	error: null
 }
 </pre>
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-=== Выполнение кода  (execute-code) ===
+== Пульт,4 кнопки (create-console) == <!--T:252-->
-Request URL: [site]/api/wizard/execute-code
+Запрос:
+<!--T:253-->
+Request URL: [site]/api/wizard/create-console
-Params:
+<!--T:254-->
+Параметры запроса:
-controller_id (required): int
+<!--T:255-->
+#controller_id (required): int
+#token (required): string, 64
+#device_name (optional): string, 256
+#code_lock (optional): string, 64 //Название кода блокировки
+#code_unlock (optional): string, 64 //Название кода разблокировки
+#code_s (optional): string, 64 //Название кода s
+#code_alarm (optional): string, 64 //Название кода оповещения
-token (required): string, 64
+<!--T:262-->
+Ответ:
-code (required): int // Берется из сгенерированных
+Пример ответа:
-Response
 <pre>
 {
-	error: null,
+	data: {
-	data: {'response' => 'OK'}
+		'response': 'OK'
+	},
+	error: null
 }
 </pre>
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-=== Добавление розетки (create-socket) ===
-Request URL: [site]/api/wizard/create-socket
-Params:
-controller_id (required): int
+== Сирена (create-siren) == <!--T:263-->
-token (required): string, 64
+Запрос:
-code_1 (required): int
+<!--T:264-->
+Request URL: [site]/api/wizard/create-siren
-code_2 (required): int
+<!--T:265-->
+Параметры запроса:
-device_name (optional): string, 256
+<!--T:266-->
+#controller_id (required): int
+#token (required): string, 64
+#device_name (optional): string, 256
+#code_on (optional): string, 64 //Название кода включения
+#code_off (optional): string, 64 //Название кода выключения
+#code_blank (optional): string, 64 //Название кода blank
-code_off (optional): string, 64 //Название кода открытия
+<!--T:272-->
+Ответ:
-code_on (optional): string, 64 //Название кода закрытия
+Пример ответа:
-RESPONSE:
 <pre>
 {
-	data: {'response':'OK'},
+	data: {
+		'response': 'OK'
+		},
 	error: null
 }
 </pre>
-= Сценарии =
+Перед отправкой параметров необходимо перевести сирену в режим обучения.
-== Список сценариев (list) ==
+== Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos) == <!--T:273-->
-request:
+Запрос:
-Request URL: [site]/api/scheduler/list/
+Request URL: [site]/api/wizard/get-meteos
+<!--T:274-->
+Параметры запроса:
+<!--T:275-->
+#controller_id (required): int
+#token (required): string, 64
-параметры запроса: (string) token
+<!--T:277-->
+Ответ:
+Пример ответа:
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"error":null,
+	"data":[
+			{
+			"id":"93",
+			"controller_id":"79",
+			"date":"1528389351",
+			"type":"7",
+			"family":"0",
+			"rf_code":null,
+			"rf_bit_len":null,
+			"rf_pulse_len":null,
+			"rf_protocol":null,
+			"rf_freq":null,
+			"ir_code":null,
+			"ir_bit_len":null,
+			"ir_address":null,
+			"ir_protocol":null,
+			"meteo_num":"0"
+			}
+		]
 }
 </pre>
-response:
+== Метеостанция: добавление (create-meteo) == <!--T:278-->
+Запрос:
-параметры ответа:
+<!--T:279-->
+Request URL: [site][site]/api/wizard/create-meteo
-Пример ответа:
+<!--T:280-->
-<pre>
+Параметры запроса:
-{
-"0":{
-	"id":9,
-	"external_id":42,
-	"name":"test_form_web",
-	"operation":"local",
-	"armed":0,
-	"type":"meteo",
-	"action_id":1,
-	"a_controller_id":6,
-	"a_device_id":112,
-	"a_code_id":0,
-	"a_device_external_id":38,
-	"a_armed":0,
-	"a_conf1":0,
-	"a_conf2":0,
-	"a_conf3":0,
-	"a_conf4":0,
-	"a_conf5":0,
-	"a_conf6":0,
-	"a_conf7":0,
-	"a_conf8":0,
-	"target_id":1,
-	"t_controller_id":6,
-	"t_device_id":119,
-	"t_code_id":203,
-	"t_device_external_id":7,
-	"t_armed":0,
-	"t_conf1":0,
-	"t_conf2":0,
-	"t_conf3":0,
-	"t_conf4":0,
-	"t_conf5":0,
-	"t_conf6":0,
-	"t_conf7":0,
-	"t_conf8":0,
-	"date":null,
-	"repetition":"0",
-	"sensor_type":"1",
-	"logic_operation":"=",
-	"value":"3",
-	"active":1
-	},
-"1":{
-	"id":10,
-	"external_id":45
-	...
-	}
-}
-</pre>
+<!--T:281-->
+#controller_id (required): int
+#token (required): string, 64
+#meteo_num (required): int //Получается в списке выше
+#device_name (optional): string, 256
+<!--T:285-->
+Ответ:
-== Обновление сценариев (update) ==
+Пример ответа:
+<pre>
+{
+	"error":null,
+	"data":{
+		"response":"OK"
+		}
+}
+</pre>
-Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера");
+== Водопроводный кран == <!--T:286-->
-на втором этапе обновляется информация о каждом действии.
-request:
+<!--T:287-->
-Request URL: [site]/api/scheduler/update/
+Порядок добавления крана:
-параметры запроса:
+) Сгенерировать коды
-(int) controller_id,
+<!--T:288-->
+) Зажать на кране кнопку, пока кран не мигнёт трижды
-(string) token
+<!--T:289-->
+) Отправить один код
-Пример запроса:
+<!--T:290-->
-<pre>
+) Нажать на кране кнопку однократно
-{
-	"controller_id": 6 ,
+<!--T:291-->
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+) Зажать на кране кнопку, пока не мигнёт 4 раза
-}
-</pre>
+<!--T:292-->
+) Отправить второй код из сгенерированных
+<!--T:293-->
+) Нажать на кране кнопку однократно
-response:
+<!--T:294-->
+) Отправить запрос на создание крана.
-параметры ответа:
-Пример ответа:
+=== Генерация кодов === <!--T:295-->
-<pre>
-{
-	"result": "Ok" // ответ что запрос ушел
-}
-</pre>
-Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)
+Запрос:
-== Информация о сценарии (info) ==
+<!--T:296-->
+Request URL: [site]/api/wizard/create-codes
-request:
+<!--T:297-->
-Request URL: [site]/api/scheduler/info/
+Параметры запроса:
-параметры запроса:
+<!--T:298-->
+#controller_id (required): int
+#token (required): string, 64
-(int) scheduler_id,
+<!--T:300-->
+Ответ:
-(string) token
+Пример ответа:
-Пример ответа:
 <pre>
 {
-	"scheduler_id": 122,
+	"error":null,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"data":
+		{
+			"response":{
+					"id":30,
+					"masks":"[6,4,0,1]",
+					"code_1":"9920950",
+					"code_2":"9920948",
+					"code_3":"9920944",
+					"code_4":"9920945"
+				}
+		}
 }
 </pre>
-response:
-параметры ответа:
-Пример ответа:
+=== Выполнение кода === <!--T:301-->
-<pre>
-{
+Запрос:
-	"id":9,
-	"external_id":42,
-	"name":"test_form_web",
-	"operation":"local",
-	"armed":0,
-	"type":"meteo",
-	"action_id":1,
-	"a_controller_id":6,
-	"a_device_id":112,
-	"a_code_id":0,
-	"a_device_external_id":38,
-	"a_armed":0,
-	"a_conf1":0,
-	"a_conf2":0,
-	"a_conf3":0,
-	"a_conf4":0,
-	"a_conf5":0,
-	"a_conf6":0,
-	"a_conf7":0,
-	"a_conf8":0,
-	"target_id":1,
-	"t_controller_id":6,
-	"t_device_id":119,
-	"t_code_id":203,
-	"t_device_external_id":7,
-	"t_armed":0,
-	"t_conf1":0,
-	"t_conf2":0,
-	"t_conf3":0,
-	"t_conf4":0,
-	"t_conf5":0,
-	"t_conf6":0,
-	"t_conf7":0,
-	"t_conf8":0,
-	"date":null,
-	"repetition":"0",
-	"sensor_type":"1",
-	"logic_operation":"=",
-	"value":"3",
-	"active":1
-}
-</pre>
+<!--T:302-->
+Request URL: [site]/api/wizard/execute-code
+<!--T:303-->
+Параметры запроса:
-= Логи пользователя (logs) =
+<!--T:304-->
-request:
+#controller_id (required): int
+#token (required): string, 64
+#code (required): int // Берется из сгенерированных
-Request URL: [site]/api/profile/logs/
+<!--T:307-->
+Ответ:
-параметры запроса: (string) token
+Пример ответа:
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	error: null,
+	data: {
+		"response":"OK"
+		}
 }
 </pre>
-response:
-параметры ответа: (object)
+=== Добавление крана === <!--T:308-->
-пример:
+Запрос:
+<!--T:309-->
+Request URL: [site]/api/wizard/create-crane-by-codes
+<!--T:310-->
+Параметры запроса:
+<!--T:311-->
+#controller_id (required): int
+#token (required): string, 64
+#code_1 (required): int
+#code_2 (required): int
+#device_name (optional): string, 256
+#code_open (optional): string, 64 //Название кода открытия
+#code_close (optional): string, 64 //Название кода закрытия
+<!--T:318-->
+Ответ:
+Пример ответа:
+<pre>
 {
+	data:{'response': 'OK'},
+	error: null
 }
+</pre>
+== Добавление розетки == <!--T:319-->
+<!--T:320-->
+Порядок добавления розетки следующий:
+<!--T:321-->
+) Сгенерировать коды
+<!--T:322-->
+) Зажать на розетке кнопку, пока она не начнет мигать
+<!--T:323-->
+) Отправить один код
-= Коды =
+<!--T:324-->
+) Зажать на розетке кнопку, пока она не начнет мигать
+<!--T:325-->
+) Отправить второй код из сгенерированых
-== Получение информации о коде (info) ==
+<!--T:326-->
+) Отправить запрос на создание розетки
-request:
-Request URL: [site]/api/property/info/
+=== Генерация кодов (create-codes) === <!--T:327-->
-параметры запроса:
+Запрос:
-(int) controller_id,
-(int) device_id,
+<!--T:328-->
+Request URL: [site]/api/wizard/create-codes
-(int) code_id,
+<!--T:329-->
+Параметры запроса:
-(string) token
+<!--T:330-->
+#controller_id (required): int
+#token (required): string, 64
+#socket (required): любое значение.
-Пример запроса:
+<!--T:333-->
-<pre>
+Ответ:
-{
-	"controller_id": 6,
-	"device_id": 109,
-	"code_id": 192,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-}
+Пример ответа:
-</pre>
-response:
-параметры ответа:
-Пример ответа:
 <pre>
 {
-	"id":"192",
+	"error":null,
-	"external_cod_id":"67",
+	"data":{
-	"device_id":"109",
+		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
-	"name":"4 OFF",
+		}
-	"code":"12209156",
-	"protocol":"1",
-	"pulse_len":null,
-	"group_1":"1",
-	"group_2":"0",
-	"group_3":"0",
-	"group_4":"0",
-	"group_5":"0",
-	"group_6":"0",
-	"group_7":"0",
-	"group_8":"0",
-	"active":"1"
 }
 </pre>
+=== Выполнение кода  (execute-code) === <!--T:334-->
-== Изменение имени кода (update-code-name) ==
+Запрос:
-Request URL: [site]/api/device/update-code-name
+<!--T:335-->
+Request URL: [site]/api/wizard/execute-code
-Request Params:
+<!--T:336-->
+Параметры запроса:
-token (required): string(64)
+<!--T:337-->
+#controller_id (required): int
+#token (required): string, 64
+#code (required): int // Берется из сгенерированных
-code_id (required): int
+<!--T:340-->
+Ответ:
-name (optional): string(255)
+Пример ответа:
-SUCCESS RESPONSE:
 <pre>
 {
-	data: {
+	error: null,
-		'message': "OK"
+	data: {'response' => 'OK'}
-		},
-	error: null
 }
 </pre>
-==  Получение кодов по типу сигнала (get-codes-by-subtype) ==
-Request URL: [site]/api/device/get-codes-by-subtype
+=== Добавление розетки (create-socket) === <!--T:341-->
-Request Params:
+Запрос:
-token (required): string(64)
+<!--T:342-->
+Request URL: [site]/api/wizard/create-socket
-device_subtype_id (optional): int, default 0.
+<!--T:343-->
+Параметры запроса:
-==  Получение списка кодов (get-codes) ==
+<!--T:344-->
+#controller_id (required): int
+#token (required): string, 64
+#code_1 (required): int
+#code_2 (required): int
+#device_name (optional): string, 256
+#code_off (optional): string, 64 //Название кода открытия
+#code_on (optional): string, 64 //Название кода закрытия
-Request URL: [site]/api/device/get-codes
+<!--T:351-->
+Ответ:
-PARAMS:
+Пример ответа:
-token (required): string 64
-controller_id (required): int
-SUCCESS RESPONSE:
 <pre>
 {
-	data: [
+	data: {'response':'OK'},
-		{
+	error: null
-			devices:	[
+}
-			{
+</pre>
-				id:	13
-				external_id:	7,
+= Сценарии = <!--T:352-->
-				controller_id:	5,
-				name:	"Simple device",
+== Получение списка сценариев (list) == <!--T:353-->
-				type_id:	2,
-				password:	null,
+<!--T:354-->
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+Запрос:
-				state:	1,
-				on_dashboard:	0,
+Request URL: [site]/api/scheduler/list/
-				active:	1,
-				new:	1,
+<!--T:355-->
-				family:	DEVICE_FAMILY_RADIO,
+Параметры запроса: (string) token
-				camera_id:	null,
-				camera_host:	null
+<!--T:356-->
-			},
+Пример запроса:
-			{
-				id:	14
+<pre>
-				external_id:	8,
+{
-				controller_id:	5,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-				name:	"Simple device",
+}
-				type_id:	2,
+</pre>
-				password:	null,
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+<!--T:357-->
-				state:	1,
+Ответ:
-				on_dashboard:	0,
-				active:	1,
+<!--T:359-->
-				new:	1,
+Пример ответа:
-				family:	DEVICE_FAMILY_RADIO,
-				camera_id:	null,
+<pre>
-				camera_host:	null
+{
-			},
+"error":null,
-		],
+"data"
-		code: {
+	"schedulers":[
-			id:	12,
+	{
-			controller_id: 5,
+		"id":83,
-			device_type_id:	2,
+		"external_id":23,
-			code: 498654,
+		"name":"Test 444",
-			protocol: 1,
+		"operation":"local",
-			bit_len: 32,
+		"armed":2,
-			pulse_len:	86,
+		"type":"meteo",
-			freq:	77,
+		"active":0,
-			address:	94,
+		"action"
-			num:	1,
+			"action_id":1,
-			date_create: '2018-04-13 18:29:11"
+			"controller_id":109,
+			"device_id":1747,
+			"code_id":1100,
+			"device_external_id":64,
+			"armed":1,
+			"groups":7,
+			"sensor_type":"1",
+			"date":"00:00",
+			"repetition":"1",
+			"logic_operation":"=",
+			"value":"9"
+		},
+		"target"
+			"target_id":2,
+			"controller_id":109,
+			"device_id":0,
+			"device_external_id":0,
+			"code_id":0,
+			"external_cod_id":0,
+			"armed":0,
+			"groups":168
+		}
+		},
+		{
+		"id":84,
+		"external_id":24,
+		...
+		}]
+	}
+}
+<!--T:360-->
+</pre>
+== Обновление/добавление сценариев (update) == <!--T:361-->
+<!--T:362-->
+Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера");
+на втором этапе обновляется информация о каждом действии.
+<!--T:363-->
+Запрос:
-		}
+Request URL: [site]/api/scheduler/update/
-		},
-		{
+<!--T:364-->
-			devices:	[
+Параметры запроса:
-			{
-				id:	13
+<!--T:365-->
-				external_id:	7,
+#(int) controller_id,
-				controller_id:	5,
+#(string) token
-				name:	"Simple device",
-				type_id:	2,
+Пример запроса:
-				password:	null,
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+<pre>
-				state:	1,
+{
-				on_dashboard:	0,
+	"controller_id": 6 ,
-				active:	1,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-				new:	1,
+}
-				family:	DEVICE_FAMILY_RADIO,
+</pre>
-				camera_id:	null,
-				camera_host:	null
+<!--T:368-->
-			},
+Ответ:
-			{
-				id:	14
+<!--T:370-->
-				external_id:	8,
+Пример ответа:
-				controller_id:	5,
-				name:	"Simple device",
+<pre>
-				type_id:	2,
+{
-				password:	null,
+	"result": "Ok" // ответ что запрос ушел
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+}
-				state:	1,
+</pre>
-				on_dashboard:	0,
-				active:	1,
+Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)
-				new:	1,
-				family:	DEVICE_FAMILY_RADIO,
+== Информация о сценарии (info) == <!--T:371-->
-				camera_id:	null,
-				camera_host:	null
+<!--T:372-->
-			},
+Запрос:
-		],
-		code: {
+Request URL: [site]/api/scheduler/info/
-			id:	12,
-			controller_id: 5,
+<!--T:373-->
-			device_type_id:	2,
+Параметры запроса:
-			code: 498654,
-			protocol: 1,
+<!--T:374-->
-			bit_len: 32,
+#(int) scheduler_id,
-			pulse_len:	86,
+#(string) token
-			freq:	77,
-			address:	94,
+<!--T:376-->
-			num:	1,
+Пример запроса:
-			date_create: '2018-04-13 18:29:11"
+<pre>
-		}
+{
-		},
+	"scheduler_id": 122,
-	},
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-	error: null,
 }
 </pre>
-== Добавление кода к устройству (set-code-to-device) ==
+Ответ:
-Request URL: [site]/api/device/set-code-to-device
+<!--T:378-->
+Пример ответа (data):
-PARAMS:
-token (required): string 64
-code_id (required): int
-device_id (required): int
-name (optional): string 256
-SUCCESS RESPONSE:
 <pre>
 {
-	data:	{
+"id":107,
-		id: 5,
+"external_id":6,
-		external_cod_id: 15,
+"name":"Test 1.1.1",
-		device_id: 14,
+"operation":"local",
-		name: "Name"
+"armed":1,
-		code: 8463517,
+"type":"device",
-		protocol: 0,
+"active":1,
-		pulse_len:	86,
+"action":{
-		active: 1,
+	"action_id":1,
-	},
+	"controller_id":111,
-	error: null
+	"device_id":1824,
+	"code_id":1399,
+	"device_external_id":18,
+	"armed":0,
+	"groups":0,
+	"sensor_type":"0",
+	"date":null,
+	"repetition":"0",
+	"logic_operation":"=",
+	"value":null
+},
+"targets":[
+		{
+		"id":87,
+		"type_id":3,
+		"controller_id":111,
+		"device_id":0,
+		"code_id":0,
+		"device_external_id":0,
+		"armed":1,
+		"groups":0
+		},
+		{
+		"id":88,
+		"type_id":1,
+		"controller_id":113,
+		"device_id":13,
+		"code_id":123,
+		"device_external_id":1234,
+		"armed":0,
+		"groups":0
+		},
+	]
 }
 </pre>
-== Удаление кода (remove-code) ==
-Request URL: [site]/api/device/remove-code
-PARAMS:
-token (required): string 64
+== Обновление сценариев (update) == <!--T:371-->
-code_id (required): int
+Обновление состоит из двух запросов: 1) обновление действия, вызывающего событие; 2) обновления целей сработки.
+При этом запросы можно делать независимо друг от друга.
-SUCCESS RESPONSE:
+=== Обновление/добавление действий и событий сценария (Update-action) ===
+Request URL: [site]/api/scheduler/update-action/
+Параметры запроса:
+#(int) scheduler_id,
+#(string) token,
+#(string) name,
+#(int) "active"
+#(int) "send_sms"  // 1 - отправлять / 0 - не отправлять
+#(int) "make_call"   // 1 - отправлять / 0 - не отправлять
+#(int) "armed"  // 0 - в любом режиме, 1 - в режиме охраны, 2 - без режима охраны
+#(int) "action_id",
+#(int) "action_device_id",
+#(int) "action_code_id",
+#(int) "action_armed",
+#(int) "action_groups",   // битовая маска группы от 1 до 8
+#(string) "action_repetition",   // только для расписания: номер дней повторения через запятую от 1 до 7
+#(string) "action_event_time",    // только для расписания: время повторения
+#(int) "action_sensor_type",  // только для метео устройств: 1 - напряжение, 2 - температура, 3 - влажность, 4 - Атм. давление, 5 - Освещенность , 0 - не выбрано
+#(string) "action_logic_operation",   // логическая операция : '=', '!=', '<', '>', '<=', '>=', 'in', 'like'
+#(int) "action_value"
+Пример запроса:
 <pre>
 {
-	data:	{
+	"scheduler_id": 6 ,
-		message: "OK"
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	},
+	"name": "New name",
-	error: null
+	"active": 1,
+	"send_sms": 0,
+	"make_call": 1,
+	"armed": 2,
+	"action_id" : 2,
+	"action_device_id" : 2,
+	"action_code_id" : 4,
+	"action_armed" : 0,
+	"action_groups" : 7,
+	"action_repetition" : "1,3",
+	"action_event_time" : "10:00",
+	"action_sensor_type" : 2,
+	"action_logic_operation" : "=",
+	"action_value" : 35,
 }
 </pre>
+Ответ:
-= События =
+Пример ответа:
+<pre>
+{
+	"result": "Ok" // ответ о том, что запрос отправлен.
+}
+</pre>
-== Нажатие кнопки на устройстве (event) ==
+=== Обновление цели события (Update-target) ===
-request:
-Request URL: [site]/api/device/event/
+Request URL: [site]/api/scheduler/update-target/
-параметры запроса:
-(string) controller_name,
+Параметры запроса:
-(int) device_external_id,
+#(int) target_id,
+#(string) token,
+#(int) "target_type_id",
+#(int) "target_device_id",
+#(int) "target_code_id",
+#(int) "target_armed",
+#(int) "target_groups",   // битовая маска группы от 1 до 8
-(int) cod_external_id,
+Пример запроса:
+<pre>
+{
+	"target_id": 6 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"target_type_id" : 2,
+	"target_device_id" : 2,
+	"target_code_id" : 4,
+	"target_armed" : 0,
+	"target_groups" : 7
+}
+</pre>
-(string) token,
+Ответ:
-(int) device_type
+Пример ответа:
-Пример запроса:
 <pre>
 {
-	"controller_name": " AS_7F26335CCF4B" ,
+	"result": "Ok" // ответ о том, что запрос отправлен.
-	"device_external_id": 19,
-	"cod_external_id": 1,
-	"device_type": 1,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-так как MQTT  односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен:
-response:
-параметры ответа:
+= Логи пользователя (logs) = <!--T:379-->
+Запрос:
+<!--T:380-->
+Request URL: [site]/api/profile/logs/
-Пример ответа:
+<!--T:381-->
+Параметры запроса: (string) token, (int) page, (int) limit
+<!--T:382-->
+Пример запроса:
 <pre>
 {
-	"result": "Ok"
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"page": 1 // номер страницы лога
+	"limit": 20 // количество логов на странице , по умолчанию 20, максимум 100
 }
 </pre>
-= Места =
+Ответ:
+Пример ответа:
-== Получение списка мест (places-list) ==
+<pre>
+[
+	{
+	"id":15,
+	"controller":"Test Valera",
+	"action_name":"",
+	"device":"",
+	"cod":"",
+	"action_pack":"",
+	"date_create":"2019-06-20 15:57:26",
+	"status":0
+	},
+	{
+	"id":14,
+	"controller":"Test Valera",
+	"action_name":"",
+	"device":"",
+	"cod":"",
+	"action_pack":"",
+	"date_create":"2019-06-20 15:57:18",
+	"status":0
+        }
+]
+</pre>
-Request URL: [site]/api/places/places-list
+= Коды = <!--T:383-->
-Request params:
+== Получение информации о коде (info) == <!--T:384-->
-token (required): string, 64
+<!--T:385-->
+Запрос:
-Response:
+<!--T:386-->
-<pre>
+Request URL: [site]/api/property/info/
-{
-	"error":null,
+<!--T:387-->
-	"data":{
+Параметры запроса:
-		"rooms":[{"id":1,"root_id":1,"user_id":424,"lvl":0,"name":"Дом","icon":0,"icon_type":1,"color":"#fff2cc","readonly":0,"visible":1},{"id":2,"root_id":1,"user_id":424,"lvl":1,"name":"Спальня","icon":0,"icon_type":1,"color":"#b6d7a8","readonly":0,"visible":1}]
+#(int) controller_id,
-		}
+#(int) device_id,
+#(int) code_id,
+#(string) token
+<!--T:391-->
+Пример запроса:
+<pre>
+{
+	"controller_id": 6,
+	"device_id": 109,
+	"code_id": 192,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
+<!--T:393-->
+Ответ:
-== Создание места (create) ==
+<!--T:394-->
+Пример ответа (data):
+<pre>
+{
+	"id":"1465",
+	"external_cod_id":"59",
+	"device_id":"1866",
+	"name":"alarm",
+	"alias":"xxx",
+	"code":"15779537",
+	"msg_cod":"003001",
+	"send_armed":"INFO",
+	"send_disarmed":"INFO",
+	"protocol":"1",
+	"pulse_len":null,
+	"group_1":"0",
+	"group_2":"0",
+	"group_3":"0",
+	"group_4":"0",
+	"group_5":"0",
+	"group_6":"0",
+	"group_7":"0",
+	"group_8":"0",
+	"active":"1",
+	"send_sms":"0",
+	"voice_call":"0"
+}
+</pre>
-Request URL: [site]/api/places/create
+== Изменение имени кода (update-code-name) == <!--T:395-->
-Request params:
+Запрос:
+<!--T:396-->
+Request URL: [site]/api/device/update-code-name
-token (required): string, 64
+<!--T:397-->
+Параметры запроса:
-root (optional): int, default 1
+<!--T:398-->
+#token (required): string(64)
+#code_id (required): int
+#name (optional): string(255)
-lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+<!--T:401-->
+Ответ:
-rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+Пример ответа:
-lvl (optional): int, default 0
+<pre>
+{
+	data: {
+		'message': "OK"
+		},
+	error: null
+}
+</pre>
-name (optional): string, 64, default 'Simple name'
+== Редактирование параметров кода (update) ==
-icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+<!--T:401-->
+Запрос:
-color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+<!--T:401-->
+Request URL: [site]/api/property/update/
-active (optional): int, default 1
+<!--T:401-->
+Параметры запроса:
-selected (optional): int, default 0
+#(string) token
+#(int) device_id
+#(int) code_id
+#(string) name		// опционально
+#(int) active		// опционально
+#(int) send_sms		// опционально
+#(int) voice_call	// опционально
-disabled (optional): int, default 0
+<!--T:401-->
+Пример запроса:
-readonly (optional): int, default 0
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"device_id" : 111,
+	"code_id" : 111,
+	"send_sms": 1
+}
+</pre>
-visible (optional): int, default 1
+<!--T:402-->
+Ответ:
-collapsed (optional): int, default 0
+<!--T:402-->
+Пример ответа (data):
-movable_u (optional): int, default 1
+<pre>
+{
+	"result": "Ok"
+}
+</pre>
-movable_d (optional): int, default 1
+==  Получение кодов по типу сигнала (get-codes-by-subtype) == <!--T:402-->
-movable_l (optional): int, default 1
+Запрос:
-movable_r (optional): int, default 1
+<!--T:403-->
+Request URL: [site]/api/device/get-codes-by-subtype
-removable (optional): int, default 1
+<!--T:404-->
+Параметры запроса:
-removable_all (optional): int, default 0
+<!--T:405-->
+#token (required): string(64)
+#device_subtype_id (optional): int, default 0.
-inverse_text (optional): string, default 'black'
+Ответ:
+Пример ответа:
-Response:
 <pre>
 {
-	error:null,
+	"code"
-	data: {'message': 'OK'}
+	"id":131,
+	"controller_id":109,
+	"device_type_id":0,
+	"device_subtype_id":1,
+	"code":"655370",
+	"protocol":1,
+	"bit_len":24,
+	"pulse_len":283,
+	"freq":2,"address":null,
+	"num":null,
+	"date_create":"2019-03-13 17:35:05",
+	"device_id":null
+	},
+	"devices":[
+	{
+		"id":"1684",
+		"external_id":"64",
+		"controller_id":"109",
+		"name":"WS 1",
+		"alias":null,
+		"type_id":"12",
+		"password":null,
+		"codes":[178,179,180],
+		"state":"1",
+		"on_dashboard":"0",
+		"active":"1",
+		"new":"1",
+		"family":"DEVICE_FAMILY_RADIO",
+		"camera_id":null,
+		"camera_host":null,
+		"send_sms":"0",
+		"voice_call":"0"
+	},
+	{
+		"id":"1738",
+		"external_id":"115",
+		"controller_id":"109",
+		"name":"Pult 123",
+		"alias":null,
+		"type_id":"3",
+		"password":null,
+		"codes":[280,281,282,283],
+		"state":"1",
+		"on_dashboard":"0",
+		"active":"1",
+		"new":"1",
+		"family":"DEVICE_FAMILY_RADIO",
+		"camera_id":null,
+		"camera_host":null,
+		"send_sms":"0",
+		"voice_call":"0"
+	}
+	]
 }
 </pre>
+==  Получение списка кодов (get-codes) == <!--T:407-->
-==  Редактирование места (edit) ==
+Запрос:
-Request URL: [site]/api/places/edit
+<!--T:408-->
+Request URL: [site]/api/device/get-codes
-Request params:
+<!--T:409-->
+Параметры:
-token (required): string, 64
+#token (required): string 64
+#controller_id (required): int
-place_id (required): int
+Ответ:
-root (optional): int, default 1
+<!--T:411-->
+Пример ответа:
-lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+<pre>
+{
-rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+	data: [
+		{
-lvl (optional): int, default 0
+			devices:	[
+			{
-name (optional): string, 64, default 'Simple name'
+				id:	13
+				external_id:	7,
-icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+				controller_id:	5,
+				name:	"Simple device",
-color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+				type_id:	2,
+				password:	null,
-active (optional): int, default 1
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+				state:	1,
-selected (optional): int, default 0
+				on_dashboard:	0,
+				active:	1,
-disabled (optional): int, default 0
+				new:	1,
+				family:	DEVICE_FAMILY_RADIO,
-readonly (optional): int, default 0
+				camera_id:	null,
+				camera_host:	null
-visible (optional): int, default 1
+			},
+			{
-collapsed (optional): int, default 0
+				id:	14
+				external_id:	8,
-movable_u (optional): int, default 1
+				controller_id:	5,
+				name:	"Simple device",
-movable_d (optional): int, default 1
+				type_id:	2,
+				password:	null,
-movable_l (optional): int, default 1
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+				state:	1,
-movable_r (optional): int, default 1
+				on_dashboard:	0,
+				active:	1,
-removable (optional): int, default 1
+				new:	1,
+				family:	DEVICE_FAMILY_RADIO,
-removable_all (optional): int, default 0
+				camera_id:	null,
+				camera_host:	null
-inverse_text (optional): string, default 'black'
+			},
+		],
+		code: {
-Response:
+			id:	12,
-<pre>
+			controller_id: 5,
-{
+			device_type_id:	2,
-	error:null,
+			code: 498654,
-	data: {'message': 'OK'}
+			protocol: 1,
+			bit_len: 32,
+			pulse_len:	86,
+			freq:	77,
+			address:	94,
+			num:	1,
+			date_create: '2018-04-13 18:29:11"
+		<!--T:412-->
 }
+		},
-</pre>
+		<!--T:413-->
-== Удаление места (delete) ==
-Request URL: [site]/api/places/delete
-Request params:
-token (required): string, 64
-place_id (required): int
-Response:
-<pre>
 {
-	error:null,
+			devices:	[
-	data: {'message': 'OK'}
+			{
-}
+				id:	13
-</pre>
+				external_id:	7,
+				controller_id:	5,
+				name:	"Simple device",
+				type_id:	2,
+				password:	null,
-== Удаление устройства (remove-device) ==
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+				state:	1,
-Request URL: [site]/api/device/remove-device
+				on_dashboard:	0,
+				active:	1,
-PARAMS:
+				new:	1,
+				family:	DEVICE_FAMILY_RADIO,
-token (required): string (64)
+				camera_id:	null,
+				camera_host:	null
-device_id (required): int
+			},
+			{
-SUCCESS RESPONSE:
+				id:	14
+				external_id:	8,
-<pre>
+				controller_id:	5,
-{
+				name:	"Simple device",
-	data: {message: 'OK'},
+				type_id:	2,
-	error: null
+				password:	null,
-}
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
-</pre>
+				state:	1,
+				on_dashboard:	0,
+				active:	1,
-=== Удаление устройства (remove-device) ===
+				new:	1,
+				family:	DEVICE_FAMILY_RADIO,
-Request URL: [site]/api/device/remove-device
+				camera_id:	null,
-PARAMS:
+				camera_host:	null
+			},
-token (required): string 64
+		],
+		code: {
+			id:	12,
+			controller_id: 5,
+			device_type_id:	2,
+			code: 498654,
+			protocol: 1,
+			bit_len: 32,
+			pulse_len:	86,
+			freq:	77,
+			address:	94,
+			num:	1,
+			date_create: '2018-04-13 18:29:11"
-device_id (required): int
+		<!--T:414-->
+}
-SUCCESS RESPONSE:
+		},
-<pre>
-{
-	data:	{
-		message: "OK"
 	},
-	error: null
+	error: null,
 }
 </pre>
+== Добавление кода к устройству (set-code-to-device) == <!--T:415-->
-==  передача локального IP Контроллера (get-ip) ==
+Запрос:
-Request URL: [site]/api/ctrl/get-ip
+<!--T:416-->
+Request URL: [site]/api/device/set-code-to-device
-Request Params:
+<!--T:417-->
+Параметры запроса:
-token (required): string(64);
+<!--T:418-->
+#token (required): string 64
+#code_id (required): int
+#device_id (required): int
+#name (optional): string 256
-controller_id (required): int;
+<!--T:422-->
+Ответ:
-SUCCESS RESPONSE:
+Пример ответа:
 <pre>
 {
-	data:'192.168.0.15',
+	data:	{
+		id: 5,
+		external_cod_id: 15,
+		device_id: 14,
+		name: "Name"
+		code: 8463517,
+		protocol: 0,
+		pulse_len:	86,
+		active: 1,
+	},
 	error: null
 }
 </pre>
+== Удаление кода (remove-code) == <!--T:423-->
-==  Активация подписки Ebus  ==
+Запрос:
+<!--T:424-->
+Request URL: [site]/api/device/remove-code
-Получение состояния подписки на Контроллере - “in/subscription/get”:
+Параметры запроса:
-<pre>
+<!--T:425-->
-{
+#token (required): string 64
-	"id": 1, // ID подписки (см. ниже)
+#code_id (required): int
-	"seq_id": 0
-}
-</pre>
+<!--T:427-->
 Ответ:
+Пример ответа:
 <pre>
 {
-	"seq_id": 0,
+	data:	{
-	"remain_time": 100, // оставшееся время в секундах, 4294967295 – неограниченно
+		message: "OK"
-	"success": 0/1
+	},
+	error: null
 }
 </pre>
-Установка подписки на Контроллере - “in/subscription/set”:
+= События = <!--T:428-->
+== Нажатие кнопки на устройстве (event) == <!--T:429-->
+<!--T:430-->
+Запрос:
+<!--T:431-->
+Request URL: [site]/api/device/event/
+Параметры запроса:
+<!--T:432-->
+#(string) controller_name,
+#(int) device_external_id,
+#(int) cod_external_id,
+#(string) token,
+#(int) device_type
+<!--T:437-->
+Пример запроса:
+<!--T:438-->
 <pre>
 {
-	"seq_id": 0,
+	"controller_name": " AS_7F26335CCF4B" ,
-	"id": 1, // ID подписки (см. ниже)
+	"device_external_id": 19,
-	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
+	"cod_external_id": 1,
+	"device_type": 1,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-Ответ:
+<!--T:439-->
-<pre>
+так как MQTT  односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен:
-{
+response:
-	"seq_id": 0,
-	"success": 0/1
-}
-</pre>
-Идентификаторы подписок:
+Ответ:
-SUBSCRIPTION_EBUS = 1
-Статус Контроллера
+<!--T:441-->
+Пример ответа (data):
-Контроллер отправляет информацию о своем онлайн/оффлайн статусе в топик “out/status”.
+<!--T:442-->
-Формат сообщения:
 <pre>
 {
-	"status": 1 // см. ниже
+	"result": "Ok"
 }
 </pre>
-Поле “status” может принимать следующие значения:
+= Места = <!--T:443-->
-• "0" – оффлайн
+== Получение списка мест (places-list) == <!--T:444-->
-• "1" – онлайн
+Запрос:
-• "2" – онлайн, после включения питания
+<!--T:445-->
+Request URL: [site]/api/places/places-list
-При получении сообщения со статусом "2", портал должен отправить Контроллеру информацию о пользовательских подписках, как это описано в разделе «Подписки».
+<!--T:446-->
+Параметры запроса: token (required): string, 64
+<!--T:448-->
+Ответ:
+Пример ответа:
-== ?? Установка подписки на Контроллере - “in/subscription/set”: ==
 <pre>
 {
-	"seq_id": 0,
+	"error":null,
-	"id": 1, // ID подписки (см. ниже)
+	"data":{
-	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
+		"rooms":[
+				{
+				"id":1,
+				"root_id":1,
+				"user_id":424,
+				"lvl":0,
+				"name":"Дом",
+				"icon":0,
+				"icon_type":1,
+				"color":"#fff2cc",
+				"readonly":0,
+				"visible":1
+				},
+				{
+				"id":2,
+				"root_id":1,
+				"user_id":424,
+				"lvl":1,
+				"name":"Спальня",
+				"icon":0,
+				"icon_type":1,
+				"color":"#b6d7a8",
+				"readonly":0,
+				"visible":1
+				}
+			]
+		}
 }
-<pre>
+</pre>
-==  Просмотр статуса подписки (get-subscribe-status) ==
-Request URL: [site]/api/ctrl/get-subscribe-status
+== Создание места (create) == <!--T:449-->
-params:
+Запрос:
-token (required): string(64)
+<!--T:450-->
+Request URL: [site]/api/places/create
-controller_id (required): int
+<!--T:451-->
+Параметры запроса:
-response:
+<!--T:452-->
+#token (required): string, 64
+#root (optional): int, default 1
+#lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+#rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+#lvl (optional): int, default 0
+#name (optional): string, 64, default 'Simple name'
+#icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+#color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+#active (optional): int, default 1
+#selected (optional): int, default 0
+#disabled (optional): int, default 0
+#readonly (optional): int, default 0
+#visible (optional): int, default 1
+#collapsed (optional): int, default 0
+#movable_u (optional): int, default 1
+#movable_d (optional): int, default 1
+#movable_l (optional): int, default 1
+#movable_r (optional): int, default 1
+#removable (optional): int, default 1
+#removable_all (optional): int, default 0
+#inverse_text (optional): string, default 'black'
-{data:{id: 1, controller_id: 40, user_id: 424, remain_time: 100, request_time: 1355314332, response_time: 1355315332, success: 0}, error: ''}
+<!--T:473-->
+Ответ:
+Пример ответа:
-==  Активация/продление/покупка подписки (set-subscribe) ==
-Request URL: [site]/api/ctrl/set-subscribe
-params:
-token (required): string(64)
-controller_id (required): int
-response:
 <pre>
 {
-	data:{
+	error:null,
-		id: 1,
+	data: {'message': 'OK'}
-		controller_id: 40,
-		user_id: 424,
-		remain_time: 100,
-		request_time: 1355314332,
-		response_time: 1355315332,
-		success: 0
-	},
-	error: ''
 }
 </pre>
-==  ? Метод получения списка телефонов (get-phones) ==
+==  Редактирование места (edit) == <!--T:474-->
-Request URL: [site]/api/ctrl/get-phones
+Запрос:
-Params:
+<!--T:475-->
+Request URL: [site]/api/places/edit
-token (required): string, 64
+<!--T:476-->
+Параметры запроса:
-controller_id (required): int
+<!--T:477-->
+#token (required): string, 64
+#place_id (required): int
+#root (optional): int, default 1
+#lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+#rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+#lvl (optional): int, default 0
+#name (optional): string, 64, default 'Simple name'
+#icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+#color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+#active (optional): int, default 1
+#selected (optional): int, default 0
+#disabled (optional): int, default 0
+#readonly (optional): int, default 0
+#visible (optional): int, default 1
+#collapsed (optional): int, default 0
+#movable_u (optional): int, default 1
+#movable_d (optional): int, default 1
+#movable_l (optional): int, default 1
+#movable_r (optional): int, default 1
+#removable (optional): int, default 1
+#removable_all (optional): int, default 0
+#inverse_text (optional): string, default 'black'
-type (optional): string,
+<!--T:499-->
-range ['recipient', 'authorized', 'all'], default 'all'
+Ответ:
-Response:
+Пример ответа:
 <pre>
 {
-	'error': null,
+	error:null,
-	data: [
+	data: {'message': 'OK'}
-		{'id': 5, 'phone': '+380123456789'},
-		{'id': 6, 'phone': '+380123334455'},
-		{'id': 7, 'phone': '+380112223344'}
-	]
 }
 </pre>
+== Удаление места (delete) == <!--T:501-->
+Запрос:
+<!--T:502-->
+Request URL: [site]/api/places/delete
-==  Редактирование телефона (edit-phone) ==
+<!--T:503-->
+Параметры запроса:
-Request URL: [site]/api/ctrl/edit-phone
+<!--T:504-->
+#token (required): string, 64
+#place_id (required): int
+<!--T:506-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	error:null,
+	data: {'message': 'OK'}
+}
+</pre>
-Params:
-token (required): string, 64
+== Добавление устройства к месту, смена места у устройства (device-in-place) == <!--T:502-->
-phone_id (required): int
+Запрос:
-is_recipient (optional): int
+Request URL: [site]/api/places/device-in-place/
-is_authorized (optional): int
+Параметры запроса:
-phone (optional): string
+#token (required): string 64
+#device_id (required): int
+#place_id (required): int
+#visible (not required): int
-Response:
+Ответ:
-<pre>
+Пример ответа:
+<pre>
 {
-	"error":null,
+	data:	{result: "OK"},
-	"data":{
+	error: null
-		"id":2,
+}
-		"controller_id":81,
+</pre>
-		"phone":"+380503334455",
-		"is_recipient":"1",
-		"is_authorized":0
+== Отвязать устройство от месту (device-out-place) == <!--T:509-->
+Запрос:
+Request URL: [site]/api/places/device-out-place/
+Параметры запроса:
+#token (required): string 64
+#device_id (required): int
+#place_id (required): int
+Ответ:
+Пример ответа:
+<pre>
+{
+	data:	{
+		result: "OK"
+	},
+	error: null
+}
+</pre>
+== Получить список связей устройство-место (device-place-list) == <!--T:519-->
+Запрос:
+Request URL: [site]/api/places/device-place-list/
+Параметры запроса:
+#token (required): string 64
+Ответ:
+Пример ответа:
+<pre>
+{
+	"error":null,
+	"data":{
+		"0":{
+			"device_id":1336,
+			"device_name":"Camera test",
+			"place_id":8,
+			"place_name":"office"
+			},
+			...
+		"10":{
+			"device_id":1865,
+			"device_name":"Meteo 9",
+			"place_id":10,
+			"place_name":"Box 1"
+			}
+		}
+}
+</pre>
+==  Активация подписки Ebus  == <!--T:507-->
+<!--T:508-->
+Получение состояния подписки на Контроллере - “in/subscription/get”:
+<!--T:509-->
+<pre>
+{
+	"id": 1, // ID подписки (см. ниже)
+	"seq_id": 0
+}
+</pre>
+<!--T:510-->
+Ответ:
+<!--T:511-->
+<pre>
+{
+	"seq_id": 0,
+	"remain_time": 100, // оставшееся время в секундах, 4294967295 – неограниченно
+	"success": 0/1
+}
+</pre>
+Установка подписки на Контроллере - “in/subscription/set”:
+<!--T:513-->
+<pre>
+{
+	"seq_id": 0,
+	"id": 1, // ID подписки (см. ниже)
+	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
+}
+</pre>
+<!--T:514-->
+Ответ:
+<pre>
+{
+	"seq_id": 0,
+	"success": 0/1
+}
+</pre>
+<!--T:515-->
+Идентификаторы подписок:
+SUBSCRIPTION_EBUS = 1
+<!--T:516-->
+Статус Контроллера
+<!--T:517-->
+Контроллер отправляет информацию о своем онлайн/оффлайн статусе в топик “out/status”.
+<!--T:518-->
+Формат сообщения:
+<pre>
+{
+	"status": 1 // см. ниже
+}
+</pre>
+<!--T:519-->
+Поле “status” может принимать следующие значения:
+<!--T:520-->
+• "0" – оффлайн
+<!--T:521-->
+• "1" – онлайн
+<!--T:522-->
+• "2" – онлайн, после включения питания
+<!--T:523-->
+При получении сообщения со статусом "2", портал должен отправить Контроллеру информацию о пользовательских подписках, как это описано в разделе «Подписки».
+= Виджеты = <!--T:524-->
+== Список виджетов пользователя (widget-list) == <!--T:525-->
+<!--T:525-->
+Запрос:
+<!--T:526-->
+Request URL: [site]/api/device/widget-list/
+<!--T:527-->
+Параметры запроса:
+(string) token
+<!--T:528-->
+Пример запроса:
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+}
+</pre>
+<!--T:529-->
+Ответ:
+<!--T:530-->
+Пример ответа (data):
+<pre>
+{
+"widgets":[
+	{
+	"controller_id":111,
+	"device_ids":[18,20,21,22],
+	"device_id":"1824",
+	"external_id":18,
+	"device_type":3,
+	"name":"Remote control",
+	"widget_type":3,
+	"state":1
+	},
+	{
+	"controller_id":111,
+	"device_ids":[18,20,21,22],
+	"device_id":"1850",
+	"external_id":20,
+	"device_type":4,
+	"name":"Sockets",
+	"widget_type":4,
+	"state":1
+	}
+   ],
+"ctrl_widgets":[
+   {
+	"controller_id":111,
+	"name":"66D4E809EF0A",
+	"hostname":"Test",
+	"armed":0
+   }
+]
+}
+</pre>
+== Добавить виджет (widget-add-home) == <!--T:525-->
+<!--T:525-->
+Запрос:
+<!--T:525-->
+Request URL: [site]/api/device/widget-add-home/
+<!--T:525-->
+Параметры запроса:
+<!--T:525-->
+#(string) token,
+#(int) device_id,
+#(int) controller_id
+<!--T:525-->
+Пример запроса:
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id": 1862
+}
+</pre>
+<!--T:525-->
+Ответ:
+<!--T:525-->
+Пример ответа (полный):
+<pre>
+{
+	"error":null,
+	"data":{
+	"result":"Ok"
+	}
+}
+</pre>
+== Удалить виджет пользователя (widget-remove-home) == <!--T:525-->
+<!--T:525-->
+Запрос:
+Request URL: [site]/api/device/widget-remove-home/
+<!--T:525-->
+Параметры запроса:
+#(string) token,
+#(int) device_id,
+#(int) controller_id
+<!--T:525-->
+Пример запроса:
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"device_id": 1862
+}
+</pre>
+<!--T:525-->
+Ответ:
+<!--T:525-->
+Пример ответа (полный):
+<pre>
+{
+	"error":null,
+	"data":{
+		"result":"Ok"
+	}
+}
+</pre>
+= Неклассифицируемые методы = <!--T:524-->
+== Список доступных стран (countries) ==
+<!--T:525-->
+Запрос:
+<!--T:526-->
+Request URL: [site]/api/profile/countries/
+<!--T:527-->
+Параметры запроса:
+#(string) token
+#(string) lang	// en , ua, ru
+<!--T:528-->
+Пример запроса:
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"lang" : "en"
+}
+</pre>
+<!--T:529-->
+Ответ:
+<!--T:530-->
+Пример ответа (data):
+<pre>
+[
+	{
+		"id":"1",
+		"code":"AF",
+		"name":"Afghanistan"
+	},
+	{
+		"id":"2",
+		"code":"AL",
+		"name":"Albania"
+	}
+]
+</pre>
+= Ошибки = <!--T:524-->
+<!--T:525-->
+параметры ошибки:
+пример:
+<!--T:526-->
+<pre>
+{
+	"errors":{
+		"password": [
+			"Incorrect username."
+		]
 	}
 }
@@ Строка 2140: / Строка 3307: @@
-==  Удаление телефона (delete-phone) ==
-Request URL: [site]/api/ctrl/delete-phone
-Params:
-token (required): string, 64
-phone_id (required): int
-Response:
-<pre>
-{
-	"error":null,
-	"data":{"response":"OK"}
-}
-</pre>
-== Добавление телефона (add-phone) ==
-Request URL: [site]/api/ctrl/add-phone
-Params:
-token (required): string, 64
-controller_id (required): int
-phone (required): string
-is_recipient (optional): int
-is_authorized (optional): int
-Response:
-<pre>
+</translate>
-{
-	"error":null,
-	"data":{
-		"id":2,
-		"controller_id":81,
-		"phone":"+380503334455",
-		"is_recipient":"1",
-		"is_authorized":0
-	}
-}
-</pre>
-</pre>
-= Ошибки =
-параметры ошибки:
-пример:
-<pre>
-{
-	"errors":{
-		"password": [
-			"Incorrect username."
-		]
-	}
-}
-</pre>

Web API: различия между версиями

Текущая версия на 17:12, 30 июля 2019

Содержание

Общие сведения

Учётная запись

Авторизация (login)

Регистрация (registration)

Профиль пользователя (profile)

Контроллеры

Список Контроллеров Пользователя (list)

Информация о Контроллере (info)

Постановка/снятие Контроллера на охрану / с охраны (armed)

Добавление Контроллера (add)

Обновление списка устройств и действий на Контроллере (update)

Этап 1 - обновляем список IDS устройств на Контроллере

Этап 2 - обновляем информацию о каждом устройстве

Удаление Контроллера (delete)

Обновление статуса контроллера (update-status)

Получение актуального статуса Контроллера (get-status)

Получение конфигурации Контроллера (config)

Изменение конфигурации контроллера(config-set)

Передача локального IP Контроллера (get-ip)

Установка подписки на Контроллере

Просмотр статуса подписки (get-subscribe-status)

Активация/продление/покупка подписки (set-subscribe)

Метод получения списка телефонов (get-phones)

Редактирование телефона (edit-phone)

Удаление телефона (delete-phone)

Добавление телефона (add-phone)

Информация о версии прошивки контроллера (fw-version-current)

Информация о последней версии прошивки контроллера (get-new-fw-version)

Устройства

Получение списка устройств пользователя (list)

Информация об устройстве (info)

Обновление информации об устройстве (update)

Удаление устройства (delete)

Получение метеоданных (last)

Получение метеоданных за период (period)

Получение данных электропитания (last)

Получение данных электропитания за период (period)

Получение данных о сторонних устройствах (other-last)

Получение данных о сторонних устройствах за период (other-period)

Wizard добавления устройств

Датчик открытия двери (create-door-open-sensor)

Датчик затопления (create-flood-sensor)

Пульт,4 кнопки (create-console)

Сирена (create-siren)

Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos)

Метеостанция: добавление (create-meteo)

Водопроводный кран

Генерация кодов

Выполнение кода

Добавление крана

Добавление розетки

Генерация кодов (create-codes)

Выполнение кода (execute-code)

Добавление розетки (create-socket)

Сценарии

Получение списка сценариев (list)

Обновление/добавление сценариев (update)

Информация о сценарии (info)

Обновление сценариев (update)

Обновление/добавление действий и событий сценария (Update-action)

Обновление цели события (Update-target)

Логи пользователя (logs)

Коды

Получение информации о коде (info)

Изменение имени кода (update-code-name)

Редактирование параметров кода (update)

Получение кодов по типу сигнала (get-codes-by-subtype)

Получение списка кодов (get-codes)

Добавление кода к устройству (set-code-to-device)

Удаление кода (remove-code)

События

Нажатие кнопки на устройстве (event)

Места

Получение списка мест (places-list)

Создание места (create)

Редактирование места (edit)

Удаление места (delete)