Текущая версия на 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: @@
-h1. API v01
+<languages />
+<translate>
+<!--T:1-->
+* API v01 *
+<!--T:2-->
 API ( json )
+<!--T:3-->
 URL https://quadrobit.com/
-= Авторизация (login) =
+= Общие сведения =
+Обмен данными между Пользователем и серверной частью системы Quadrobit Smart Home осуществляется путём отправки пакетов (запросов и ответов).
+Пакет отправляется по HTTP методом POST на указанный адрес Request URL.
+Запрос может содержать JSON-структуру, включающую один или несколько параметров.
+После успешной авторизации Пользователя запрос всегда должен содержать параметр token.
+В ответ на полученный запрос Сервер возвращает Пользователю следующую JSON-структуру:
+<pre>
+{
+	error: null,
+	data: { ... }
+}
+</pre>
+Параметр error содержит информацию о результате выполнения запроса. error: null - запрос выполнен успешно.
-request:
+Структура и содержание параметра data определяется типом запроса.
-Адрес: [site] /api/login
-параметры запроса: (string) email , (string) password
-пример:
+= Учётная запись = <!--T:4-->
+== Авторизация (login) ==
+<!--T:5-->
+Запрос:
+<!--T:6-->
+Request URL: [site]/api/login
+<!--T:7-->
+Параметры запроса:
+<!--T:8-->
+#(string) email,
+#(string) password
+<!--T:10-->
+Пример запроса:
 <pre>
 {
@@ Строка 17: / Строка 56: @@
 }
 </pre>
-response:
-параметры ответа: (object)
+<!--T:11-->
-пример:
+Ответ:
+<!--T:12-->
+Пример ответа (data):
 <pre>
 {
@@ Строка 35: / Строка 77: @@
 }
+<!--T:13-->
 </pre>
-= Регистрация (registration) =
+== Регистрация (registration) == <!--T:14-->
+<!--T:15-->
+Запрос:
+Request URL: [site]/api/registration
+<!--T:16-->
+Параметры запроса:
-request:
+<!--T:17-->
-Адрес: [site] /api/registration
+#(string) email,
-параметры запроса: (string) email , (string) password
+#(string) password
-пример:
+<!--T:19-->
+Пример запроса:
 <pre>
 {
@@ Строка 50: / Строка 103: @@
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (object)
-пример:
+Пример ответа (data):
 <pre>
 {
@@ Строка 67: / Строка 120: @@
-= Профиль пользователя (profile) =
+== Профиль пользователя (profile) == <!--T:20-->
-request:
+<!--T:21-->
-Адрес: [site] /api/profile/
+Запрос:
-параметры запроса: (string) token
-пример:
+<!--T:22-->
+Request URL: [site]/api/profile/
+<!--T:23-->
+Параметры запроса: (string) token
+<!--T:24-->
+Пример запроса:
 <pre>
 {
@@ Строка 78: / Строка 138: @@
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (object)
-пример:
+Пример ответа (data):
 <pre>
 {
@@ Строка 100: / Строка 160: @@
 </pre>
-= Список помещений Пользователя (rooms) =
+= Контроллеры = <!--T:25-->
-request:
+== Список Контроллеров Пользователя (list) == <!--T:26-->
-Адрес: [site] /api/profile/rooms/
-параметры запроса: (string) token
+<!--T:27-->
-пример:
+Запрос:
+Request URL: [site]/api/ctrl/list/
+<!--T:28-->
+Параметры запроса: (string) token
+<!--T:29-->
+Пример запроса:
 <pre>
 {
@@ Строка 111: / Строка 180: @@
 }
 </pre>
-response:
-параметры ответа: (object)
+<!--T:30-->
-пример:
+Ответ:
+<!--T:32-->
+Пример ответа (data):
 <pre>
 {
 "0":{
-	"id":19,  //ID дирректории
+	"id": 651,
-	"root_id":0,  //ID корневой дирректории, 0 - верхний уровень
+	"name": "AE439648F951",
-	"user_id":10,
+	"ip": "192.168.10.135",
-	"lvl":0, // уровень вложенности текущей дирректории
+	"fw_id": "1",
-	"name":"Дом",
+	"hostname": "quadrobase",
-	"icon_id":21,
+	"armed": 0,
-	"icon_type":1,
+	"address": "",
-	"color":"#674ea7", //цвет фона
+	"lat": null,
-	"position":0,	//позиция сортировки
+	"lng": null,
-	"readonly":0,	// если 1 - только для чтения, нельзя изменять
+	"timezone": 2,
-	"visible":1	//активно/неактивно
+	"online": 1,
-},
+	"last_online": "2019-06-17 19:36:48",
-"1":{
+	"type_signal": "wifi",
-	"id":22,
+	"wifi_param": -67,
-	"root_id":19,
+	"gsm_param": 0,
-	...
+	"phone": "",
-	}
+	"pin": 0,
-}
+	"user_controller_name": "quadrobase",
+	"on_dashboard": 0
+}]
 </pre>
+== Информация о Контроллере (info) == <!--T:33-->
-= Информация о помещении (room-info) =
+<!--T:34-->
+Запрос:
-request:
-Адрес: [site] /api/profile/room-info/
+Request URL: [site]/api/ctrl/info/
-параметры запроса: (string) token, (int) room_id
-пример:
+<!--T:35-->
+Параметры запроса:
+#(int) controller_id,
+#(string) token
+<!--T:36-->
+Пример запроса:
 <pre>
 {
-	"room_id":22,
+	"controller_id": 1 ,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа: (object)
+<!--T:37-->
-пример:
+Ответ:
+<!--T:39-->
+Пример ответа (data):
+<!--T:40-->
 <pre>
 {
-	"id":19,  //ID локации
+	"id":"6",
-	"root_id":0,  //ID корневой локации, 0 - верхний уровень
+	"name":"66D4E809EF0A",
-	"user_id":10,
+	"hostname":"Test Valera 34",
-	"lvl":0, // уровень вложенности текущей локации
+	"armed":0,
-	"name":"Дом",
+	"address":"",
-	"icon_id":21,
+	"lat":50.4156,
-	"icon_type":1,
+	"lng":30.5336,
-	"color":"#674ea7", //цвет фона
+	"ip":"192.168.1.155",
-	"position":0,	//позиция сортировки
+	"fw_id":1,
-	"readonly":0,	// если 1 - только для чтения, нельзя изменять
+	"timezone":3,
-	"visible":1	//активно/неактивно
+	"online":1,
-	"devices_ids {  // IDs устройств прикрепленных к комнате
+	"last_online":"2019-07-29 17:08:41",
-		"0":101,
+	"type_signal":"wifi",
-		"1":103
+	"wifi_param":-78,
-		}
+	"gsm_param":0,
+	"phone":"",
+	"pin":0,
+	"user_controller_name":"Test Valera 34",
+	"on_dashboard":0
 }
 </pre>
+== Постановка/снятие Контроллера на охрану / с охраны  (armed) == <!--T:41-->
+<!--T:42-->
+Запрос:
-= Список Контроллеров Пользователя (list) =
+<!--T:43-->
+Request URL: [site]/api/ctrl/armed/
-request:
+<!--T:44-->
-Адрес: [site] /api/ctrl/list/
+Параметры запроса:
-параметры запроса: (string) token
-пример:
+№(int) controller_id,
+№(string) token
+Пример запроса:
+<!--T:45-->
 <pre>
 {
+	"controller_id": 6 ,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа: (array)
+Так как MQTT односторонний - ответа быть не может. Ответ что запрос ушел:
-пример:
+Ответ:
+Пример ответа (data):
 <pre>
 {
-"0":{
+	"result": "Ok"
-	"id":"11",
+}
-	"name":"AS_A61301A020E4",
+</pre>
-	"armed":"0",   //0 - снят с охраны, 1 - под охраной
-	"device_ids":"a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}", //ids устройств на контроллере
-	"action_ids":"a:0:{}", //ids действий на контроллере
+== Добавление Контроллера (add) == <!--T:46-->
-	"timezone":"3",
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+<!--T:47-->
-	"online":"1"
+Запрос:
-},
-"1":{
-	"id":"12",
-	"name":"AS_A61301A020E5",
-	"armed":"1",
-	"device_ids":"a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}",
-	"action_ids":"a:0:{}",
-	"timezone":"2",
-	"token":"734D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
-	"online":"0"
-}]
-</pre>
+<!--T:48-->
+Request URL: [site]/api/ctrl/add
-= Информация о Контроллере (info) =
+<!--T:49-->
+Параметры запроса: (string) token
-request:
+<!--T:50-->
-Адрес: [site] /api/ctrl/info/
+Пример:
-параметры запроса: (int) controller_id , (string) token
-пример:
 <pre>
 {
-	"controller_id": 1 ,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа: (object)
-пример:
+Ответ:
+Пример ответа:
 <pre>
 {
-	"id":"6",
+	"PIN":"7gDH"
-	"name":"AS_7F26335CCF4B",
-	"armed":"1",
-	"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;}",
-	"action_ids":"a:4:{i:0;i:45;i:1;i:46;i:2;i:49;i:3;i:42;}",
-	"timezone":"3",
-	"token":"660D91C2B0926A8C981AE7DA4AAA4421A3D86D136262A6F8E98ACF534A7A715B",
-	"online":"1"
 }
 </pre>
-= Постановка/снятие Контроллера на охрану / с охраны  (armed) =
+После ввода пин-кода необходимо обновить список Контроллеров (/api/ctrl/list/)
+== Обновление списка устройств и действий на Контроллере (update) == <!--T:51-->
+=== Этап 1 - обновляем список IDS устройств на Контроллере === <!--T:52-->
+Запрос:
-request:
+<!--T:53-->
-Адрес: [site] /api/ctrl/armed/
+Request URL: [site]/api/ctrl/update/
-параметры запроса: (int) controller_id , (string) token
-пример:
+Параметры запроса:
+#(int) controller_id,
+#(string) token
+Пример запроса:
 <pre>
 {
@@ Строка 255: / Строка 350: @@
 }
 </pre>
-так как MQTT  односторонний - ответа быть не может. Ответ что запрос ушел:
-response:
+Ответ:
-параметры ответа:
-пример:
+Пример ответа (data):
 <pre>
 {
-	"result": "Ok"
+	"result": "Ok" // "Ok" = запрос отправлен
 }
 </pre>
+=== Этап 2 - обновляем информацию о каждом устройстве === <!--T:54-->
-== Добавление Контроллера (add) =
+<!--T:55-->
+Запрос:
-request:
+Request URL: [site]/api/ctrl/update-devices/
-Адрес: [site] /api/ctrl/add
-параметры запроса: (string) token
+<!--T:56-->
-пример:
+Параметры запроса:
+<!--T:57-->
+#(int) controller_id,
+#(string) token
+<!--T:58-->
+Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"controller_id": 6 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
 }
 </pre>
-response:
-параметры ответа:
+<!--T:59-->
-пример:
+Ответ:
+<!--T:61-->
+Пример ответа:
 <pre>
 {
-	"PIN":"7gDH"
+	"result": "Ok" // Запрос отправлен
 }
 </pre>
-после ввода пин-кода необходимо обновить список Контроллеров (/api/ctrl/list/)
-= Обновление списка устройств и действий на Контроллере (update) =
+Процесс происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (контроллер, устройства)
-=== Этап 1 - обновляем список IDS устройств на Контроллере ===
-request:
+== Удаление Контроллера (delete) == <!--T:62-->
-Адрес: [site] /api/ctrl/update/
-параметры запроса: (int) controller_id , (string) token
+Запрос:
-пример:
+<!--T:63-->
+Request URL: [site]/api/ctrl/delete
+<!--T:65-->
+Пример запроса:
 <pre>
 {
-	"controller_id": 6 ,
+	"token":"8yE-VIQrYuZ2bTeho_lajxjOJPnIe_Yx",
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"controller_id":"81"
 }
 </pre>
-response:
-параметры ответа:
+<!--T:66-->
-пример:
+Ответ:
+Пример ответа:
 <pre>
 {
-	"result": "Ok" // "Ok" = запрос ушел
+	"error":null,
+	"data":{"result":"Ok"}
 }
 </pre>
-=== Этап 2 - обновляем информацию о каждом устройстве ===
+== Обновление статуса контроллера (update-status) == <!--T:67-->
+<!--T:68-->
+Запрос:
+<!--T:69-->
+Request URL: [site]/api/ctrl/update-status/
-request:
+<!--T:70-->
-Адрес: [site] /api/ctrl/update-devices/
+Параметры запроса:
-параметры запроса:
+#(string) token,
+#(int) controller_id
+<!--T:73-->
+Пример запроса:
-(int) controller_id , (string) token
-пример:
 <pre>
 {
-	"controller_id": 6 ,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id": 122
 }
 </pre>
-response:
-параметры ответа:
+<!--T:74-->
-пример:
+Ответ:
+<!--T:76-->
+Пример ответа:
 <pre>
 {
-	"result": "Ok" // ответ что запрос ушел
+	"error":null,
+	"data":{
+		"result":"Ok"
+		}
 }
 </pre>
-Процесс происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (контроллер, устройства)
+== Получение актуального статуса Контроллера (get-status) ==  <!--T:77-->
+Запрос:
+<!--T:78-->
+Request URL: [site]/api/ctrl/get-status/
+<!--T:79-->
+Параметры запроса:
+#(string) token,
+#(int) controller_id
-= Удаление Контроллера (delete) =
+<!--T:82-->
+Пример запроса:
-request:
-Адрес: [site] /api/ctrl/del
-параметры запроса:
-пример:
 <pre>
 {
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id": 122
 }
 </pre>
-response:
-параметры ответа:
+<!--T:83-->
-пример:
+Ответ:
+<!--T:85-->
+Пример ответа:
 <pre>
 {
+	"error":null,
+	"data":{
+		"status":1
+		}
 }
 </pre>
+<!--T:86-->
+Поле “status” может принимать следующие значения:
+• 0 – офлайн
-= Список устройств пользователя (list) =
+<!--T:87-->
+• 1 – онлайн
+<!--T:88-->
+• 2 – онлайн, после включения питания
+== Получение конфигурации Контроллера (config) == <!--T:89-->
+<!--T:82-->
+Запрос:
+Request URL: [site]/api/ctrl/config/
+<!--T:82-->
+Параметры запроса:
+#(string) token,
+#(int) controller_id
+<!--T:82-->
+Пример запроса:
-request:
-Адрес: [site] /api/device/list/
-параметры запроса: (int) controller_id , (string) token
-пример:
 <pre>
 {
-	"controller_id": 1 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"controller_id" : 111
 }
 </pre>
-response:
-параметры ответа:
+<!--T:82-->
-пример:
+Ответ:
+<!--T:82-->
+Пример ответа (data):
+<pre>
+{
+	"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"
+}
+</pre>
+== Изменение конфигурации контроллера(config-set) == <!--T:89-->
+<!--T:89-->
+Запрос:
+Request URL: [site]/api/ctrl/config-set/
+<!--T:89-->
+Параметры запроса:
+#(string) token,
+#(int) controller_id
+<!--T:89-->
+Пример запроса:
 <pre>
 {
-"0":{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"id":"122",
+	"controller_id" : 111,
-	"external_id":"19", //id на контроллере
+	"command": "yyy"    // параметры контроллера смотри метод Получить конфигурацию контроллера(ctrl/config/)
-	"controller_id":"6",
+}
-	"name":"Сирена",
+</pre>
-	"type_id":"2",  //тип устройства
-	"codes":":{     //коды (кнопки)
+<!--T:89-->
-		"0":{
+Ответ:
-		"id":"218",
-		"external_cod_id":"32",
+<!--T:89-->
-		"device_id":"122",
+Пример ответа (data):
-		"name":"ON",
-		"code":"3675192",
+<pre>
-		"protocol":"1",
+{
-		"pulse_len":null,
+	"result": "Ok"
-		"group_1":"1",
+}
-		"group_2":"0",
+</pre>
-		"group_3":"0",
-		"group_4":"0",
+==  Передача локального IP Контроллера (get-ip) == <!--T:89-->
-		"group_5":"0",
-		"group_6":"0",
+Запрос
-		"group_7":"0",
-		"group_8":"0",
+<!--T:90-->
-		"active":"1"
+Request URL: [site]/api/ctrl/get-ip
-		},
-		"1":{ ... }
+<!--T:91-->
-	},
+Request Params:
-	"state":"1",
-	"on_dashboard":"1", //показывать на главной
+#token (required): string(64);
-	"active":"1"
+#controller_id (required): int;
-},
-"1":{
-	"id":"120",
-	"external_id":"22",
-	"controller_id":"6",
-	"name":"Пульт 4кн бел",
-	"type_id":"3",
-	"codes": ... ,
-	"state":"1",
-	"on_dashboard":"0",
-	"active":"1"
-}
-}
-</pre>
+Ответ:
+<!--T:94-->
-= Информация об устройстве (info) =
+Пример ответа:
-request:
+<!--T:95-->
-Адрес: [site] /api/device/info/
-параметры запроса: (int) controller_id , (int) device_id , (string) token
-пример:
 <pre>
 {
-	"controller_id": 1 ,
+	data:'192.168.0.15',
-	"device_id": 122,
+	error: null
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа:
+== Установка подписки на Контроллере == <!--T:96-->
-пример:
+Запрос:
+<!--T:97-->
+Request URL: [site]/in/subscription/set”
+Ответ:
+Пример ответа (data):
 <pre>
 {
-	"id":"122",
+	"seq_id": 0,
-	"external_id":"19",
+	"id": 1, // ID подписки (см. ниже)
-	"controller_id":"6",
+	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
-	"name":"Сирена",
+}
-	"type_id":"2",
+</pre>
-	"codes":{
-		"0":{
+==  Просмотр статуса подписки (get-subscribe-status) == <!--T:98-->
-		"id":"218",
-		"external_cod_id":"32",
+Запрос:
-		"device_id":"122",
-		"name":"ON",
+<!--T:99-->
-		"code":"3675192",
+Request URL: [site]/api/ctrl/get-subscribe-status
-		"protocol":"1",
-		"pulse_len":null,
+<!--T:100-->
-		"group_1":"1",
+Параметры:
-		"group_2":"0",
-		"group_3":"0",
+<!--T:101-->
-		"group_4":"0",
+#token (required): string(64)
-		"group_5":"0",
+#controller_id (required): int
-		"group_6":"0",
-		"group_7":"0",
+<!--T:103-->
-		"group_8":"0",
+Ответ:
-		"active":"1"
-		},
+Пример ответа (data):
-		"1":{
-		"id":"219",
+<!--T:104-->
-		"external_cod_id":"33",
+<pre>
-		"device_id":"122",
+{
-		"name":"OFF",
+	data:{
-		"code":"3675186
+		id: 1,
-		...
+		controller_id: 40,
-		}
+		user_id: 424,
+		remain_time: 100,
+		request_time: 1355314332,
+		response_time: 1355315332,
+		success: 0
 	},
-	"state":"1",
+	error: ''
-	"on_dashboard":"1",
-	"active":"1"
 }
 </pre>
-= Нажатие кнопки на устройстве (event) =
+==  Активация/продление/покупка подписки (set-subscribe) == <!--T:105-->
+Запрос:
+<!--T:106-->
+Request URL: [site]/api/ctrl/set-subscribe
-request:
+<!--T:107-->
-Адрес: [site] /api/device/event/
+Параметры:
-параметры запроса: (string) controller_name , (int) device_external_id, (int) cod_external_id,       (string) token, (int) device_type
-пример:
+<!--T:108-->
-<pre>
+#token (required): string(64)
+#controller_id (required): int
+<!--T:110-->
+Ответ:
+<pre>
 {
-	"controller_name": " AS_7F26335CCF4B" ,
+	data:{
-	"device_external_id": 19,
+		id: 1,
-	"cod_external_id": 1,
+		controller_id: 40,
-	"device_type": 1,
+		user_id: 424,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+		remain_time: 100,
+		request_time: 1355314332,
+		response_time: 1355315332,
+		success: 0
+	},
+	error: ''
 }
 </pre>
-так как MQTT  односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен:
-response:
+==  Метод получения списка телефонов (get-phones) == <!--T:111-->
-параметры ответа:
-пример:
+Запрос:
+<!--T:112-->
+Request URL: [site]/api/ctrl/get-phones
+<!--T:113-->
+Параметры:
+<!--T:114-->
+#token (required): string, 64
+#controller_id (required): int
+#type (optional): string,
+#range ['recipient', 'authorized', 'all'], (default: 'all')
+<!--T:117-->
+Ответ:
+Пример ответа:
+<!--T:118-->
 <pre>
 {
-	"result": "Ok"
+	'error': null,
+	data: [
+		{'id': 5, 'phone': '+380123456789'},
+		{'id': 6, 'phone': '+380123334455'},
+		{'id': 7, 'phone': '+380112223344'}
+	]
 }
 </pre>
-= Обновление информации об устройстве (update) =
+==  Редактирование телефона (edit-phone) == <!--T:119-->
-request:
+Запрос:
-Адрес: [site] /api/device/update/
-параметры запроса: (int) device_id , (string) name, (int) active, (string) token,
+<!--T:120-->
-пример:
+Request URL: [site]/api/ctrl/edit-phone
+<!--T:121-->
+Параметры:
+<!--T:122-->
+#token (required): string, 64
+#phone_id (required): int
+#is_recipient (optional): int
+#is_authorized (optional): int
+#phone (optional): string
+<!--T:127-->
+Ответ:
+Пример ответа:
 <pre>
 {
-	"device_id": 107,   // local device id
+	"error":null,
-	"name": "New name", // new name
+	"data":{
-	"active": 1,
+		"id":2,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+		"controller_id":81,
+		"phone":"+380503334455",
+		"is_recipient":"1",
+		"is_authorized":0
+	}
 }
 </pre>
-response:
-параметры ответа:
-пример:
+==  Удаление телефона (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>
 {
-	"resuls" : "Ok"
+	"error":null,
+	"data":{"response":"OK"}
 }
 </pre>
-= Удаление устройства (delete) =
+== Добавление телефона (add-phone) == <!--T:134-->
-request:
+Запрос:
-Адрес: [site] /api/device/delete/
-параметры запроса: (int) device_id, (string) token
+<!--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>
 {
-	"device_id": 107,   // local device id
+	"error":null,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"data":{
+		"id":2,
+		"controller_id":81,
+		"phone":"+380503334455",
+		"is_recipient":"1",
+		"is_authorized":0
+	}
 }
 </pre>
-response:
-параметры ответа:
-пример:
-<pre>
-{
-	"resuls" : "Ok"
-}
+== Информация о версии прошивки контроллера (fw-version-current) == <!--T:145-->
-</pre>
+Запрос:
+Request URL: [site]/api/ctrl/fw-version-current/
+Параметры запроса:
-Код:
+#(int) controller_id,
+#(string) token
-= Получение информации об устройстве(info) =
+Пример запроса:
-request:
-Адрес: [site] /api/property/info/
-параметры запроса: (int) controller_id, (int) device_id, (int) code_id, (string) token
-пример:
 <pre>
 {
-	"controller_id": 6,
+	"controller_id": 1 ,
-	"device_id": 109,
-	"code_id": 192,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа:
+Ответ:
-пример:
+Пример ответа (data):
 <pre>
 {
-	"id":"192",
+	"version_id":1,
-	"external_cod_id":"67",
+	"version_name":"0.01",
-	"device_id":"109",
+	"tag":"OLD",
-	"name":"4 OFF",
+	"url":"\/controllers_fw\/NULL.bin",
-	"code":"12209156",
+	"date":"16.10.2018",
-	"protocol":"1",
+	"new_version_id":38   // если "new_version_id" != "version_id" значит имеется новая версия.
-	"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>
-= (create) ?? =
+== Информация о последней версии прошивки контроллера (get-new-fw-version) == <!--T:145-->
+Запрос:
+Request URL: [site]/api/ctrl/get-new-fw-version/
+Параметры запроса:
+#(int) controller_id,
+#(string) token
-request:
-Адрес: [site] /api/
-параметры запроса:
-пример:
 <pre>
+Пример запроса:
 {
+	"controller_id": 1 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа:
+Ответ:
-пример:
+Пример ответа (data):
 <pre>
 {
+	"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"
 }
 </pre>
-= (update) ?? =
+= Устройства = <!--T:144-->
-request:
+== Получение списка устройств пользователя (list) == <!--T:145-->
-Адрес: [site] /api/property/update/
+<!--T:146-->
-параметры запроса: (int) device_id , (int) code_id,  (string)name, (int) active,  (string) token
+Запрос:
-пример:
-<pre>
-{
-	"device_id": 107,   // local device id
-	"name": "New name", // new name
-	"active": 1,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-}
-</pre>
-response:
-параметры ответа:
-пример:
-<pre>
-{
-	"resuls" : "Ok"
-}
-</pre>
-= (delete) ?? =
+<!--T:147-->
-request:
+Request URL: [site]/api/device/list
-Адрес: [site] /api/
-параметры запроса:
-пример:
-{
-}
-response:
-параметры ответа:
-пример:
-{
-}
+<!--T:148-->
+Параметры запроса:
+#(int) controller_id,
+#(string) token
-= Список действий (list) =
+<!--T:149-->
-h3. (list)
+Пример запроса:
-request:
-Адрес: [site] /api/scheduler/list/
-параметры запроса: (string) token
-пример:
 <pre>
 {
+	"controller_id": 1 ,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа:
+<!--T:150-->
-пример:
+Ответ:
+Пример ответа (data):
 <pre>
 {
 "0":{
-	"id":9,
+	"id":"122",
-	"external_id":42,
+	"external_id":"19", //id на контроллере
-	"name":"test_form_web",
+	"controller_id":"6",
-	"operation":"local",
+	"name":"Сирена",
-	"armed":0,
+	"type_id":"2",  //тип устройства
-	"type":"meteo",
+	"codes":":{     //коды (кнопки)
-	"action_id":1,
+		"0":{
-	"a_controller_id":6,
+		"id":"218",
-	"a_device_id":112,
+		"external_cod_id":"32",
-	"a_code_id":0,
+		"device_id":"122",
-	"a_device_external_id":38,
+		"name":"ON",
-	"a_armed":0,
+		"code":"3675192",
-	"a_conf1":0,
+		"protocol":"1",
-	"a_conf2":0,
+		"pulse_len":null,
-	"a_conf3":0,
+		"group_1":"1",
-	"a_conf4":0,
+		"group_2":"0",
-	"a_conf5":0,
+		"group_3":"0",
-	"a_conf6":0,
+		"group_4":"0",
-	"a_conf7":0,
+		"group_5":"0",
-	"a_conf8":0,
+		"group_6":"0",
-	"target_id":1,
+		"group_7":"0",
-	"t_controller_id":6,
+		"group_8":"0",
-	"t_device_id":119,
+		"active":"1"
-	"t_code_id":203,
+		},
-	"t_device_external_id":7,
+		"1":{ ... }
-	"t_armed":0,
+	},
-	"t_conf1":0,
+	"state":"1",
-	"t_conf2":0,
+	"on_dashboard":"1", //показывать на главной
-	"t_conf3":0,
+	"active":"1"
-	"t_conf4":0,
+},
-	"t_conf5":0,
+"1":{
-	"t_conf6":0,
+	"id":"120",
-	"t_conf7":0,
+	"external_id":"22",
-	"t_conf8":0,
+	"controller_id":"6",
-	"date":null,
+	"name":"Пульт 4кн бел",
-	"repetition":"0",
+	"type_id":"3",
-	"sensor_type":"1",
+	"codes": ... ,
-	"logic_operation":"=",
+	"state":"1",
-	"value":"3",
+	"on_dashboard":"0",
-	"active":1
+	"active":"1"
-	},
+	}
-"1":{
+}
-	"id":10,
+</pre>
-	"external_id":45
-	...
-	}
+== Информация об устройстве (info) == <!--T:151-->
-}
+<!--T:152-->
-</pre>
+Запрос:
+<!--T:153-->
-= Обновление действий (update) =
+Request URL: [site]/api/device/info/
-Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера");
-на втором этапе обновляется информация о каждом действии.
-request:
-Адрес: [site] /api/scheduler/update/
-параметры запроса: (int) controller_id, (string) token
-пример:
-<pre>
-{
-	"controller_id": 6 ,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-}
-</pre>
-response:
-параметры ответа:
-пример:
-<pre>
-{
-	"result": "Ok" // ответ что запрос ушел
-}
-</pre>
-Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)
+<!--T:154-->
+Параметры запроса:
-= Информация о действии (info) =
+<!--T:155-->
+#(int) controller_id,
+#(int) device_id,
+#(string) token
-request:
+<!--T:158-->
-Адрес: [site] /api/scheduler/info/
+Пример запроса:
-параметры запроса: (int) scheduler_id, (string) token
-пример:
 <pre>
 {
-	"scheduler_id": 122,
+	"controller_id": 1 ,
+	"device_id": 122,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа:
+<!--T:159-->
-пример:
+Ответ:
+Пример ответа (data):
 <pre>
 {
-	"id":9,
+	"id":"122",
-	"external_id":42,
+	"external_id":"19",
-	"name":"test_form_web",
+	"controller_id":"6",
-	"operation":"local",
+	"name":"Сирена",
-	"armed":0,
+	"type_id":"2",
-	"type":"meteo",
+	"codes"
-	"action_id":1,
+		"0"
-	"a_controller_id":6,
+			"id":"218",
-	"a_device_id":112,
+			"external_cod_id":"32",
-	"a_code_id":0,
+			"device_id":"122",
-	"a_device_external_id":38,
+			"name":"ON",
-	"a_armed":0,
+			"code":"3675192",
-	"a_conf1":0,
+			"protocol":"1",
-	"a_conf2":0,
+			"pulse_len":null,
-	"a_conf3":0,
+			"group_1":"1",
-	"a_conf4":0,
+			"group_2":"0",
-	"a_conf5":0,
+			"group_3":"0",
-	"a_conf6":0,
+			"group_4":"0",
-	"a_conf7":0,
+			"group_5":"0",
-	"a_conf8":0,
+			"group_6":"0",
-	"target_id":1,
+			"group_7":"0",
-	"t_controller_id":6,
+			"group_8":"0",
-	"t_device_id":119,
+			"active":"1",
-	"t_code_id":203,
+		},
-	"t_device_external_id":7,
+		"1"
-	"t_armed":0,
+			"id":"219",
-	"t_conf1":0,
+			"external_cod_id":"33",
-	"t_conf2":0,
+			"device_id":"122",
-	"t_conf3":0,
+			"name":"OFF",
-	"t_conf4":0,
+			"code":"3675186
-	"t_conf5":0,
+		...
-	"t_conf6":0,
+		}
-	"t_conf7":0,
+	},
-	"t_conf8":0,
+	"state":"1",
-	"date":null,
+	"on_dashboard":"1",
-	"repetition":"0",
+	"active":"1",
-	"sensor_type":"1",
+	"alias":"xxx",
-	"logic_operation":"=",
+	"send_sms ":0,
-	"value":"3",
+	"voice_call":0,
-	"active":1
+	place"
+		"name":null,
+		"color":null
+		}
 }
-</pre>
+</pre>
+== Обновление информации об устройстве (update) == <!--T:161-->
-=== (create) ===
+<!--T:162-->
-request:
+Запрос:
-Адрес: [site] /api/
-параметры запроса:
+<!--T:163-->
-пример:
+Request URL: [site]/api/device/update/
+<!--T:164-->
+Параметры запроса:
+<!--T:165-->
+#(int) device_id,
+#(string) name,
+#(int) active,
+#(string) token,
+<!--T:169-->
+Пример запроса (data):
+<pre>
 {
+	"device_id": 107,   // local device id
+	"name": "New name", // new name
+	"active": 1,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
-response:
+</pre>
-параметры ответа:
-пример:
-{
-}
+Ответ:
+Пример ответа (data):
-=== (update) ===
+<pre>
-request:
-Адрес: [site] /api/
-параметры запроса:
-пример:
 {
+	"result" : "Ok"
 }
-response:
+</pre>
-параметры ответа:
-пример:
-{
-}
+== Удаление устройства (delete) == <!--T:171-->
-=== (delete)===
+<!--T:172-->
-request:
+Запрос:
-Адрес: [site] /api/login
-параметры запроса:
+<!--T:173-->
-пример:
+Request URL: [site]/api/device/delete/
-{
+<!--T:174-->
-}
+Параметры запроса:
-response:
-параметры ответа:
+<!--T:175-->
-пример:
+#(int) device_id,
-{
+#(string) token
-}
+<!--T:177-->
+Пример запроса:
-= Логи пользователя (logs) =
-request:
-Адрес: [site] /api/profile/logs/
-параметры запроса: (string) token
-пример:
 <pre>
 {
+	"device_id": 107,   // local device id
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-параметры ответа: (object)
+<!--T:178-->
-пример:
+Ответ:
+<!--T:180-->
+Пример ответа (data):
+<pre>
 {
+	"result" : "Ok"
 }
-________________________________________
+</pre>
+== Получение метеоданных (last) == <!--T:182-->
+<!--T:183-->
+Запрос:
+Request URL: [site]/api/device/meteo-last/
-= Получение метеоданных (last) =
+<!--T:184-->
+Параметры запроса:
+<!--T:185-->
+#(string) token,
+#(int) device_id
+<!--T:187-->
+Пример запроса:
-request:
-Адрес: [site] /api/device/meteo-last/
-параметры запроса: (string) token, (int) device_id
-пример:
 <pre>
 {
@@ Строка 880: / Строка 1207: @@
 }
 </pre>
-response:
-параметры ответа: (object)
+Ответ:
-пример:
+<!--T:189-->
+Пример ответа (data):
+<!--T:190-->
 <pre>
 {
@@ Строка 900: / Строка 1231: @@
 </pre>
-= Получение метеоданных за период (period) =
+== Получение метеоданных за период (period) == <!--T:191-->
-request:
-Адрес: [site] /api/device/meteo-period/
+Запрос:
-параметры запроса: (string) token, (int) device_id, (int) period
-пример:
+<!--T:192-->
+Request URL: [site]/api/device/meteo-period/
+<!--T:193-->
+Параметры запроса:
+<!--T:194-->
+#(string) token,
+(int) device_id,
+#(int) period
+<!--T:197-->
+Пример запроса:
 <pre>
 {
@@ Строка 913: / Строка 1257: @@
 </pre>
-response:
+<!--T:198-->
-параметры ответа: (array to objects)
+Ответ:
-пример:
+<!--T:199-->
+параметры ответа (array to objects):
+<!--T:200-->
+Пример ответа (data):
 <pre>
 [
@@ Строка 940: / Строка 1290: @@
 </pre>
-= Получение данных электропитания (last) =
+== Получение данных электропитания (last) == <!--T:201-->
+Запрос:
+Request URL: [site]/api/device/electro-last/
+<!--T:202-->
+Параметры запроса:
+<!--T:203-->
+#(string) token,
+#(int) device_id
+<!--T:205-->
+Пример запроса:
-request:
-Адрес: [site] /api/device/electro-last/
-параметры запроса: (string) token, (int) device_id
-пример:
 <pre>
 {
@@ Строка 952: / Строка 1312: @@
 }
 </pre>
-response:
-параметры ответа: (object)
+<!--T:206-->
-пример:
+Ответ:
+<!--T:208-->
+Пример ответа (data):
+<!--T:209-->
 <pre>
 {
@@ Строка 975: / Строка 1340: @@
 </pre>
-= Получение данных электропитания за период (period) =
+== Получение данных электропитания за период (period) == <!--T:210-->
-request:
+Запрос:
-Адрес: [site] /api/device/electro-period/
-параметры запроса: (string) token, (int) device_id, (int) period
+<!--T:211-->
-пример:
+Request URL: [site]/api/device/electro-period/
+<!--T:212-->
+Параметры запроса:
+<!--T:213-->
+#(string) token,
+#(int) device_id,
+#(int) period
+<!--T:216-->
+Пример запроса:
 <pre>
 {
@@ Строка 988: / Строка 1365: @@
 }
 </pre>
-response:
-параметры ответа: (array to objects)
+Ответ:
-пример:
+<!--T:217-->
+Параметры ответа: (array to objects)
+<!--T:218-->
+Пример ответа (data):
 <pre>
 [
@@ Строка 1018: / Строка 1401: @@
 </pre>
-= ?? Остальные устройства данные (last) =
+== Получение данных о сторонних устройствах (other-last) == <!--T:219-->
+<!--T:220-->
+Метод возвращает информацию о последнем обнаруженном стороннем устройстве.
+Запрос:
+<!--T:221-->
+Request URL: [site]/api/device/other-last/
+<!--T:222-->
+Параметры запроса:
+<!--T:223-->
+#(string) token,
+#(int) device_id
+<!--T:225-->
+Пример запроса:
-request:
-Адрес: [site] /api/device/other-last/
-параметры запроса: (string) token, , (int) device_id
-пример:
 <pre>
 {
@@ Строка 1030: / Строка 1427: @@
 }
 </pre>
-response:
-параметры ответа: (object)
+Ответ:
-пример:
+<!--T:227-->
+Пример ответа (data):
 <pre>
 {
@@ Строка 1052: / Строка 1451: @@
-=?? (period) =
+== Получение данных о сторонних устройствах за период (other-period) == <!--T:228-->
-request:
-Адрес: [site] /api/device/other-period/
+Запрос:
-параметры запроса: (string) token, (int) device_id, (int) period
-пример:
+<!--T:229-->
+Request URL: [site]/api/device/other-period/
+<!--T:230-->
+Параметры запроса:
+<!--T:231-->
+#(string) token,
+#(int) device_id,
+#(int) period
+<!--T:234-->
+Пример запроса:
+<pre>
 {
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
@@ Строка 1062: / Строка 1475: @@
 	"period": 1 // количество дней
 }
-response:
+</pre>
-параметры ответа: (array to objects)
-пример:
+Ответ:
+<!--T:236-->
+Пример ответа (data):
 <pre>
 {
@@ Строка 1087: / Строка 1504: @@
 }
 </pre>
-________________________________________
-=== Ошибки: ===
+= Wizard добавления устройств  = <!--T:237-->
-параметры ошибки:
-пример:
-<pre>
+== Датчик открытия двери (create-door-open-sensor) == <!--T:238-->
-{
-	"errors":{
+Запрос:
-		"password": [
-			"Incorrect username."
+<!--T:239-->
-		]
+URL:  [site]/api/wizard/create-door-open-sensor
-	}
-}
+<!--T:240-->
-</pre>
+Параметры запроса:
-= Получение списка иконок мест (places) =
+#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 //Название кода садящейся батареи
-Адрес: [site] /api/places/get-icons
+<!--T:241-->
+Ответ:
 Пример ответа:
 <pre>
 {
-	"error":null,
+	data:{
-	"data":{"home":"Home","industry":"Factory","calculator":"Office","shopping-cart":"Market","cubes":"Warehouse","beer":"Bar","building":"Room","flask":"Laboratory","wrench":"Workshop","bell":"Living room","coffee":"Kitchen","car":"Garage","tree":"Outside"}
+		'response': 'OK'
+		},
+	error: null
 }
+</pre>
+<!--T:242-->
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-= Получение списка созданных мест (index) =
+==  Датчик затопления (create-flood-sensor) == <!--T:243-->
-Адрес: [site] /api/places/index
+Запрос:
-Request params:
+<!--T:244-->
-token (required): string, 64
+Request URL: [site]/api/wizard/create-flood-sensor
-Response:
+<!--T:245-->
+Параметры запроса:
+<!--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 //Название кода садящейся батареи
+<!--T:251-->
+Ответ:
+Пример ответа:
 <pre>
 {
-	"error":null,
+	data: {
-	"data":{
+		'response': 'OK'
-		"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}]
+		},
-		}
+	error: null
 }
 </pre>
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-= Создание места (create) =
+== Пульт,4 кнопки (create-console) == <!--T:252-->
-Адрес: [site] /api/places/create
+Запрос:
-Request params:
+<!--T:253-->
+Request URL: [site]/api/wizard/create-console
-token (required): string, 64
+<!--T:254-->
+Параметры запроса:
-root (optional): int, default 1
+<!--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 //Название кода оповещения
-lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+<!--T:262-->
+Ответ:
-rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+Пример ответа:
-lvl (optional): int, default 0
+<pre>
+{
+	data: {
+		'response': 'OK'
+	},
+	error: null
+}
+</pre>
-name (optional): string, 64, default 'Simple name'
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
-color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+== Сирена (create-siren) == <!--T:263-->
-active (optional): int, default 1
+Запрос:
-selected (optional): int, default 0
+<!--T:264-->
+Request URL: [site]/api/wizard/create-siren
-disabled (optional): int, default 0
+<!--T:265-->
+Параметры запроса:
-readonly (optional): int, default 0
+<!--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
-visible (optional): int, default 1
+<!--T:272-->
+Ответ:
-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'
-Response:
 <pre>
 {
-	error:null,
+	data: {
-	data: {'message': 'OK'}
+		'response': 'OK'
+		},
+	error: null
 }
 </pre>
+Перед отправкой параметров необходимо перевести сирену в режим обучения.
-=  Редактирование места (edit) =
-Адрес: [site] /api/places/edit
+== Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos) == <!--T:273-->
-Request params:
+Запрос:
-token (required): string, 64
+Request URL: [site]/api/wizard/get-meteos
-place_id (required): int
+<!--T:274-->
+Параметры запроса:
-root (optional): int, default 1
+<!--T:275-->
+#controller_id (required): int
+#token (required): string, 64
-lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+<!--T:277-->
+Ответ:
-rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+Пример ответа:
-lvl (optional): int, default 0
+<pre>
+{
+	"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>
-name (optional): string, 64, default 'Simple name'
+== Метеостанция: добавление (create-meteo) == <!--T:278-->
-icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+Запрос:
-color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+<!--T:279-->
+Request URL: [site][site]/api/wizard/create-meteo
-active (optional): int, default 1
+<!--T:280-->
+Параметры запроса:
-selected (optional): int, default 0
+<!--T:281-->
+#controller_id (required): int
+#token (required): string, 64
+#meteo_num (required): int //Получается в списке выше
+#device_name (optional): string, 256
-disabled (optional): int, default 0
+<!--T:285-->
+Ответ:
-readonly (optional): int, default 0
+Пример ответа:
-visible (optional): int, default 1
+<pre>
+{
-collapsed (optional): int, default 0
+	"error":null,
+	"data":{
+		"response":"OK"
+		}
+}
+</pre>
-movable_u (optional): int, default 1
+== Водопроводный кран == <!--T:286-->
-movable_d (optional): int, default 1
+<!--T:287-->
+Порядок добавления крана:
-movable_l (optional): int, default 1
+) Сгенерировать коды
-movable_r (optional): int, default 1
+<!--T:288-->
+) Зажать на кране кнопку, пока кран не мигнёт трижды
-removable (optional): int, default 1
+<!--T:289-->
+) Отправить один код
-removable_all (optional): int, default 0
+<!--T:290-->
+) Нажать на кране кнопку однократно
-inverse_text (optional): string, default 'black'
+<!--T:291-->
+) Зажать на кране кнопку, пока не мигнёт 4 раза
+<!--T:292-->
+) Отправить второй код из сгенерированных
-Response:
+<!--T:293-->
-<pre>
+) Нажать на кране кнопку однократно
-{
-	error:null,
+<!--T:294-->
-	data: {'message': 'OK'}
+) Отправить запрос на создание крана.
-}
+=== Генерация кодов === <!--T:295-->
-</pre>
+Запрос:
-= Удаление места (delete) =
+<!--T:296-->
+Request URL: [site]/api/wizard/create-codes
-Адрес: [site] /api/places/delete
+<!--T:297-->
+Параметры запроса:
-Request params:
+<!--T:298-->
+#controller_id (required): int
+#token (required): string, 64
-token (required): string, 64
+<!--T:300-->
+Ответ:
-place_id (required): int
+Пример ответа:
-Response:
 <pre>
 {
-	error:null,
+	"error":null,
-	data: {'message': 'OK'}
+	"data":
+		{
+			"response":{
+					"id":30,
+					"masks":"[6,4,0,1]",
+					"code_1":"9920950",
+					"code_2":"9920948",
+					"code_3":"9920944",
+					"code_4":"9920945"
+				}
+		}
 }
 </pre>
-= Обновление статуса контроллера (update-status) =
-request:
+=== Выполнение кода === <!--T:301-->
-Адрес: [site] /api/ ctrl/update-status/
+Запрос:
+<!--T:302-->
+Request URL: [site]/api/wizard/execute-code
+<!--T:303-->
+Параметры запроса:
+<!--T:304-->
+#controller_id (required): int
+#token (required): string, 64
+#code (required): int // Берется из сгенерированных
-Параметры запроса: (string) token, (int) controller_id
+<!--T:307-->
+Ответ:
-пример:
+Пример ответа:
-<pre>
-{
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"controller_id": 122
-}
-</pre>
-response:
-параметры ответа:
-пример:
 <pre>
 {
-	"error":null,
+	error: null,
-	"data":{
+	data: {
-		"resuls":"Ok"
+		"response":"OK"
 		}
 }
 </pre>
-= Получение актуального статуса Контроллера (get-status) =
+=== Добавление крана === <!--T:308-->
-request:
-Адрес: [site] /api/ ctrl/get-status/
-параметры запроса: (string) token, (int) controller_id
-пример:
-<pre>
-{
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"controller_id": 122
-}
-</pre>
-response:
+Запрос:
-параметры ответа:
-пример:
-<pre>
-{
-	"error":null,
-	"data":{
-		"status":1
-		}
-}
-</pre>
-Поле “status” может принимать следующие значения:
+<!--T:309-->
-• 0 – офлайн
+Request URL: [site]/api/wizard/create-crane-by-codes
-• 1 – онлайн
-• 2 – онлайн, после включения питания
-= Добавление устройств через wizard =
+<!--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 //Название кода закрытия
-== Датчик открытия двери (create-door-open-sensor) ==
+<!--T:318-->
+Ответ:
-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:{
+	data:{'response': 'OK'},
-		'response': 'OK'
-		},
 	error: null
 }
 </pre>
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+== Добавление розетки == <!--T:319-->
+<!--T:320-->
+Порядок добавления розетки следующий:
-==  Датчик затопления (create-flood-sensor) ==
+<!--T:321-->
+) Сгенерировать коды
-URL
+<!--T:322-->
-/api/wizard/create-flood-sensor
+) Зажать на розетке кнопку, пока она не начнет мигать
-Params:
+<!--T:323-->
+) Отправить один код
-controller_id (required): int
+<!--T:324-->
-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 //Название кода садящейся батареи
-RESPONSE:
+<!--T:325-->
-<pre>
+) Отправить второй код из сгенерированых
-{
-	data: {
+<!--T:326-->
-		'response': 'OK'
+) Отправить запрос на создание розетки
-		},
-	error: null
-}
+=== Генерация кодов (create-codes) === <!--T:327-->
-</pre>
----------------------------------------
+Запрос:
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+<!--T:328-->
+Request URL: [site]/api/wizard/create-codes
+<!--T:329-->
+Параметры запроса:
-== Пульт,4 кнопки (create-console) ==
+<!--T:330-->
+#controller_id (required): int
+#token (required): string, 64
+#socket (required): любое значение.
-URL: [site]/api/wizard/create-console
+<!--T:333-->
+Ответ:
-Params:
+Пример ответа:
-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 //Название кода оповещения
-RESPONSE:
 <pre>
 {
-	data: {
+	"error":null,
-		'response': 'OK'
+	"data":{
-	},
+		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
-	error: null
+		}
 }
 </pre>
----------------------------------------
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+=== Выполнение кода  (execute-code) === <!--T:334-->
-== Сирена (create-siren) ==
+Запрос:
-URL  [site]/api/wizard/create-siren
+<!--T:335-->
+Request URL: [site]/api/wizard/execute-code
-Params:
+<!--T:336-->
+Параметры запроса:
+<!--T:337-->
+#controller_id (required): int
+#token (required): string, 64
+#code (required): int // Берется из сгенерированных
-controller_id (required): int
+<!--T:340-->
-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
-RESPONSE:
+Пример ответа:
 <pre>
 {
-	data: {
+	error: null,
-		'response': 'OK'
+	data: {'response' => 'OK'}
-		},
-	error: null
 }
 </pre>
----------------------------------------
-Перед отправкой параметров необходимо перевести сирену в режим обучения.
-== Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos) ==
+=== Добавление розетки (create-socket) === <!--T:341-->
-URL: [site]/api/wizard/get-meteos
-Params:
+Запрос:
-controller_id (required): int
+<!--T:342-->
-token (required): string, 64
+Request URL: [site]/api/wizard/create-socket
-RESPONSE:
+<!--T:343-->
-<pre>
+Параметры запроса:
-{
-	"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>
-== Метеостанция: добавление (create-meteo) ==
+<!--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 //Название кода закрытия
-URL: [site]/api/wizard/create-meteo
+<!--T:351-->
+Ответ:
-Params:
+Пример ответа:
-controller_id (required): int
-token (required): string, 64
-meteo_num (required): int //Получается в списке выше
-device_name (optional): string, 256
-RESPONSE:
 <pre>
 {
-	"error":null,
+	data: {'response':'OK'},
-	"data":{
+	error: null
-		"response":"OK"
-		}
 }
 </pre>
+= Сценарии = <!--T:352-->
+== Получение списка сценариев (list) == <!--T:353-->
-== Водопроводный кран ==
+<!--T:354-->
+Запрос:
-Порядок добавления крана:
+Request URL: [site]/api/scheduler/list/
-) Сгенерировать коды
-) Зажать на кране кнопку, пока кран не мигнёт трижды
-) Отправить один код
-) Нажать на кране кнопку однократно
-) Зажать на кране кнопку, пока не мигнёт 4 раза
-) Отправить второй код из сгенерированных
-) Нажать на кране кнопку однократно
-) Отправить запрос на создание крана.
+<!--T:355-->
+Параметры запроса: (string) token
-=== Генерация кодов ===
+<!--T:356-->
+Пример запроса:
-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"}
-		}
 }
 </pre>
+<!--T:357-->
+Ответ:
-=== Выполнение кода ===
+<!--T:359-->
+Пример ответа:
-URL: [site]/api/wizard/execute-code
-Params:
-controller_id (required): int
-token (required): string, 64
-code (required): int // Берется из сгенерированных
-Response:
 <pre>
 {
-	error: null,
+"error":null,
-	data: {
+"data"
-		"response":"OK"
+	"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,
+		...
+		}]
+	}
 }
+<!--T:360-->
 </pre>
-=== Добавление крана ===
+== Обновление/добавление сценариев (update) == <!--T:361-->
+<!--T:362-->
+Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера");
+на втором этапе обновляется информация о каждом действии.
-URL: [site]/api/wizard/create-crane-by-codes
+<!--T:363-->
+Запрос:
-Params:
+Request URL: [site]/api/scheduler/update/
+<!--T:364-->
+Параметры запроса:
-controller_id (required): int
+<!--T:365-->
-token (required): string, 64
+#(int) controller_id,
-code_1 (required): int
+#(string) token
-code_2 (required): int
-device_name (optional): string, 256
-code_open (optional): string, 64 //Название кода открытия
-code_close (optional): string, 64 //Название кода закрытия
-RESPONSE:
+Пример запроса:
 <pre>
 {
-	data:{'response': 'OK'},
+	"controller_id": 6 ,
-	error: null
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
 }
 </pre>
-== Добавление розетки ==
+<!--T:368-->
+Ответ:
-порядок добаления розетки следующий:
+<!--T:370-->
-) Сгенерировать коды
+Пример ответа:
-) Зажать на розетке кнопку, пока она не начнет мигать
-) Отправить один код
+<pre>
-) Зажать на розетке кнопку, пока она не начнет мигать
+{
-) Отправить второй код из сгенерированых
+	"result": "Ok" // ответ что запрос ушел
-) Отправить запрос на создание розетки
-=== Генерация кодов: ===
-URL: [site]/api/wizard/create-codes
-Params:
-controller_id (required): int
-token (required): string, 64
-socket (required): любое значение.
-Response:
-<pre>
-{
-	"error":null,
-	"data":{
-		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
-		}
 }
 </pre>
+Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)
+== Информация о сценарии (info) == <!--T:371-->
-=== Выполнение кода  (execute-code) ===
+<!--T:372-->
+Запрос:
-URL: [site]/api/wizard/execute-code
+Request URL: [site]/api/scheduler/info/
-Params:
+<!--T:373-->
+Параметры запроса:
-controller_id (required): int
+<!--T:374-->
-token (required): string, 64
+#(int) scheduler_id,
-code (required): int // Берется из сгенерированных
+#(string) token
-Response
+<!--T:376-->
+Пример запроса:
 <pre>
 {
-	error: null,
+	"scheduler_id": 122,
-	data: {'response' => 'OK'}
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
+Ответ:
-=== Добавление розетки (create-socket) ===
+<!--T:378-->
+Пример ответа (data):
-URL: [site]/api/wizard/create-socket
+<pre>
-Params:
+{
+"id":107,
-controller_id (required): int
+"external_id":6,
-token (required): string, 64
+"name":"Test 1.1.1",
-code_1 (required): int
+"operation":"local",
-code_2 (required): int
+"armed":1,
-device_name (optional): string, 256
+"type":"device",
-code_off (optional): string, 64 //Название кода открытия
+"active":1,
-code_on (optional): string, 64 //Название кода закрытия
+"action":{
+	"action_id":1,
-RESPONSE:
+	"controller_id":111,
-<pre>
+	"device_id":1824,
-{
+	"code_id":1399,
-	data: {'response':'OK'},
+	"device_external_id":18,
-	error: null
+	"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>
-= Изменение имени кода (update-code-name) =
-Request URL: [site]/api/device/update-code-name
+== Обновление сценариев (update) == <!--T:371-->
-Request Params:
+Обновление состоит из двух запросов: 1) обновление действия, вызывающего событие; 2) обновления целей сработки.
+При этом запросы можно делать независимо друг от друга.
-token (required): string(64)
+=== Обновление/добавление действий и событий сценария (Update-action) ===
-code_id (required): int
-name (optional): string(255)
-SUCCESS RESPONSE:
+Request URL: [site]/api/scheduler/update-action/
-<pre>
-{
-	data: {
-		'message': "OK"
-		},
-	error: null
-}
-</pre>
+Параметры запроса:
-== ?? Получение кодов по семейству (get-codes-by-subtype) ==
+#(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"
-Request URL: [site]/api/device/get-codes-by-subtype
+Пример запроса:
+<pre>
+{
+	"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,
+}
+</pre>
+Ответ:
-Request Params:
+Пример ответа:
-token (required): string(64)
+<pre>
-device_subtype_id (optional): int, default 0.
+{
+	"result": "Ok" // ответ о том, что запрос отправлен.
+}
+</pre>
+=== Обновление цели события (Update-target) ===
-== ?? методы управлениями places ==
-/api/places/index -- Дубликат метода /api/profile/rooms =======================================================
+Request URL: [site]/api/scheduler/update-target/
-Add Place:
-/api/places/create
+Параметры запроса:
-Request params:
+#(int) target_id,
-token (required) : string(64);
+#(string) token,
-root (optional): int, default 1;
+#(int) "target_type_id",
-lft (optional): int, default 1;
+#(int) "target_device_id",
-rgt (optional): int, default 4;
+#(int) "target_code_id",
-lvl (optional): int, default 0;
+#(int) "target_armed",
-name (optional): string(255), default "Simple name";
+#(int) "target_groups",   // битовая маска группы от 1 до 8
-icon (optional): string(255), default "";
-icon_type (optional): int, default 1;
-color (optional): string(8), default "#ccc";
-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(6), default "black";
-Response:
+Пример запроса:
 <pre>
 {
-data: {"message" => "OK"},
+	"target_id": 6 ,
-error: null
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"target_type_id" : 2,
+	"target_device_id" : 2,
+	"target_code_id" : 4,
+	"target_armed" : 0,
+	"target_groups" : 7
 }
 </pre>
+Ответ:
-=== Edit Place ===
+Пример ответа:
-/api/places/edit
-Request params:
-token (required) : string(64);
-place_id (required) : int;
-root (optional): int, default 1;
-lft (optional): int, default 1;
-rgt (optional): int, default 4;
-lvl (optional): int, default 0;
-name (optional): string(255), default "Simple name";
-icon (optional): string(255), default "";
-icon_type (optional): int, default 1;
-color (optional): string(8), default "#ccc";
-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(6), default "black";
-Response:
 <pre>
- {
+{
-data: {"message": "OK"},
+	"result": "Ok" // ответ о том, что запрос отправлен.
-error: null
+}
-} </pre>
+</pre>
-===Delete Place ===
+= Логи пользователя (logs) = <!--T:379-->
-/api/places/delete
+Запрос:
-Request params:
+<!--T:380-->
-token (required) : string(64);
+Request URL: [site]/api/profile/logs/
-place_id (required) : int;
-Response: {
+<!--T:381-->
-data: {"message": "OK"},
+Параметры запроса: (string) token, (int) page, (int) limit
-error: null
-}
+<!--T:382-->
-== Get Icons ==
+Пример запроса:
-/api/places/get-icons
-Response:
 <pre>
 {
-data: {"home": "Home", "industry": "Factory", ...},
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-error: null
+	"page": 1 // номер страницы лога
+	"limit": 20 // количество логов на странице , по умолчанию 20, максимум 100
 }
 </pre>
+Ответ:
+Пример ответа:
-== Удаление уствройств ==
+<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>
+= Коды = <!--T:383-->
+== Получение информации о коде (info) == <!--T:384-->
+<!--T:385-->
+Запрос:
+<!--T:386-->
+Request URL: [site]/api/property/info/
-REQUEST URL: /api/device/remove-device
+<!--T:387-->
-PARAMS:
+Параметры запроса:
+#(int) controller_id,
+#(int) device_id,
+#(int) code_id,
+#(string) token
-token (required): string (64)
+<!--T:391-->
-device_id (required): int
+Пример запроса:
-SUCCESS RESPONSE:
 <pre>
 {
-data: {message: 'OK'},
+	"controller_id": 6,
-error: null
+	"device_id": 109,
+	"code_id": 192,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
+<!--T:393-->
+Ответ:
+<!--T:394-->
+Пример ответа (data):
-==  Добавление кодов ==
-=== Получение списка кодов и подходящих устройств: ===
-REQUEST URL: /api/device/get-codes
-PARAMS:
-token (required): string 64
-controller_id (required): int
-SUCCESS RESPONSE:
 <pre>
 {
-	data: [
+	"id":"1465",
-		{
+	"external_cod_id":"59",
-			devices:	[
+	"device_id":"1866",
-			{
+	"name":"alarm",
-				id:	13
+	"alias":"xxx",
-				external_id:	7,
+	"code":"15779537",
-				controller_id:	5,
+	"msg_cod":"003001",
-				name:	"Simple device",
+	"send_armed":"INFO",
-				type_id:	2,
+	"send_disarmed":"INFO",
-				password:	null,
+	"protocol":"1",
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+	"pulse_len":null,
-				state:	1,
+	"group_1":"0",
-				on_dashboard:	0,
+	"group_2":"0",
-				active:	1,
+	"group_3":"0",
-				new:	1,
+	"group_4":"0",
-				family:	DEVICE_FAMILY_RADIO,
+	"group_5":"0",
-				camera_id:	null,
+	"group_6":"0",
-				camera_host:	null
+	"group_7":"0",
-			},
+	"group_8":"0",
-			{
+	"active":"1",
-				id:	14
+	"send_sms":"0",
-				external_id:	8,
+	"voice_call":"0"
-				controller_id:	5,
+}
-				name:	"Simple device",
+</pre>
-				type_id:	2,
-				password:	null,
+== Изменение имени кода (update-code-name) == <!--T:395-->
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
-				state:	1,
+Запрос:
-				on_dashboard:	0,
+<!--T:396-->
-				active:	1,
+Request URL: [site]/api/device/update-code-name
-				new:	1,
-				family:	DEVICE_FAMILY_RADIO,
+<!--T:397-->
-				camera_id:	null,
+Параметры запроса:
-				camera_host:	null
-			},
+<!--T:398-->
-		],
+#token (required): string(64)
-		code: {
+#code_id (required): int
-			id:	12,
+#name (optional): string(255)
-			controller_id: 5,
-			device_type_id:	2,
+<!--T:401-->
-			code: 498654,
+Ответ:
-			protocol: 1,
-			bit_len: 32,
+Пример ответа:
-			pulse_len:	86,
-			freq:	77,
+<pre>
-			address:	94,
+{
-			num:	1,
+	data: {
-			date_create: '2018-04-13 18:29:11"
+		'message': "OK"
+		},
+	error: null
+}
+</pre>
+== Редактирование параметров кода (update) ==
+<!--T:401-->
+Запрос:
+<!--T:401-->
+Request URL: [site]/api/property/update/
+<!--T:401-->
+Параметры запроса:
+#(string) token
+#(int) device_id
+#(int) code_id
+#(string) name		// опционально
+#(int) active		// опционально
+#(int) send_sms		// опционально
+#(int) voice_call	// опционально
-		}
+<!--T:401-->
-		},
+Пример запроса:
-		{
+<pre>
-			devices:	[
+{
-			{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-				id:	13
+	"device_id" : 111,
-				external_id:	7,
+	"code_id" : 111,
-				controller_id:	5,
+	"send_sms": 1
-				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:402-->
-				state:	1,
+Ответ:
-				on_dashboard:	0,
-				active:	1,
+<!--T:402-->
-				new:	1,
+Пример ответа (data):
-				family:	DEVICE_FAMILY_RADIO,
-				camera_id:	null,
+<pre>
-				camera_host:	null
+{
-			},
+	"result": "Ok"
-			{
+}
-				id:	14
+</pre>
-				external_id:	8,
-				controller_id:	5,
+==  Получение кодов по типу сигнала (get-codes-by-subtype) == <!--T:402-->
-				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;}",
+<!--T:403-->
-				state:	1,
+Request URL: [site]/api/device/get-codes-by-subtype
-				on_dashboard:	0,
-				active:	1,
+<!--T:404-->
-				new:	1,
+Параметры запроса:
-				family:	DEVICE_FAMILY_RADIO,
-				camera_id:	null,
+<!--T:405-->
-				camera_host:	null
+#token (required): string(64)
-			},
+#device_subtype_id (optional): int, default 0.
-		],
-		code: {
+Ответ:
-			id:	12,
-			controller_id: 5,
+Пример ответа:
-			device_type_id:	2,
-			code: 498654,
+<pre>
-			protocol: 1,
+{
-			bit_len: 32,
+	"code"
-			pulse_len:	86,
+	"id":131,
-			freq:	77,
+	"controller_id":109,
-			address:	94,
+	"device_type_id":0,
-			num:	1,
+	"device_subtype_id":1,
-			date_create: '2018-04-13 18:29:11"
+	"code":"655370",
+	"protocol":1,
-		}
+	"bit_len":24,
-		},
+	"pulse_len":283,
-	},
+	"freq":2,"address":null,
-	error: 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-->
+Запрос:
-=== Добавление кода к устройству: ===
+<!--T:408-->
+Request URL: [site]/api/device/get-codes
-REQUEST URL: /api/device/set-code-to-device
+<!--T:409-->
-PARAMS:
+Параметры:
-token (required): string 64
-code_id (required): int
-device_id (required): int
-name (optional): string 256
-SUCCESS RESPONSE:
+#token (required): string 64
-<pre>
+#controller_id (required): int
-{
-	data:	{
+Ответ:
-		id: 5,
-		external_cod_id: 15,
-		device_id: 14,
-		name: "Name"
-		code: 8463517,
-		protocol: 0,
-		pulse_len:	86,
-		active: 1,
-	},
-	error: null
-}
-</pre>
+<!--T:411-->
+Пример ответа:
-=== Удаление устройства: ===
-REQUEST URL: /api/device/remove-device
-PARAMS:
-token (required): string 64
-device_id (required): int
-SUCCESS RESPONSE:
 <pre>
 {
-	data:	{
+	data: [
-		message: "OK"
+		{
-	},
+			devices:	[
-	error: null
+			{
-}
+				id:	13
-</pre>
+				external_id:	7,
+				controller_id:	5,
-=== Удаление кода: ===
+				name:	"Simple device",
-REQUEST URL: /api/device/remove-code
+				type_id:	2,
-PARAMS:
+				password:	null,
-token (required): string 64
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
-code_id (required): int
+				state:	1,
+				on_dashboard:	0,
-SUCCESS RESPONSE:
+				active:	1,
-<pre>
+				new:	1,
-{
+				family:	DEVICE_FAMILY_RADIO,
-	data:	{
+				camera_id:	null,
-		message: "OK"
+				camera_host:	null
-	},
+			},
-	error: null
+			{
-}
+				id:	14
-</pre>
+				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;}",
-Request URI
+				state:	1,
-/api/ctrl/get-ip
+				on_dashboard:	0,
+				active:	1,
-Request Params
+				new:	1,
-token (required): string(64);
+				family:	DEVICE_FAMILY_RADIO,
-controller_id (required): int;
+				camera_id:	null,
+				camera_host:	null
-SUCCESS RESPONSE:
+			},
+		],
-<pre>
+		code: {
-{data:'192.168.0.15', error: null}
+			id:	12,
-</pre>
+			controller_id: 5,
+			device_type_id:	2,
+			code: 498654,
+			protocol: 1,
+			bit_len: 32,
-==  Ebus - активация подписки. ==
+			pulse_len:	86,
+			freq:	77,
+			address:	94,
+			num:	1,
+			date_create: '2018-04-13 18:29:11"
-Подписки
+		<!--T:412-->
-Получение состояния подписки на контроллере - “in/subscription/get”:
-{
-"id": 1, // ID подписки (см. ниже)
-"seq_id": 0
 }
+		},
-Ответ: {
+		<!--T:413-->
-"seq_id": 0,
-"remain_time": 100, // оставшееся время в секундах, 4294967295 – неограниченно
-"success": 0/1
-}
-Установка подписки на контроллере - “in/subscription/set”:
 {
-"seq_id": 0,
+			devices:	[
-"id": 1, // ID подписки (см. ниже)
+			{
-"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
+				id:	13
-}
+				external_id:	7,
+				controller_id:	5,
-Ответ: {
+				name:	"Simple device",
-"seq_id": 0,
+				type_id:	2,
-"success": 0/1
+				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,
-SUBSCRIPTION_EBUS = 1
+				active:	1,
+				new:	1,
-Статус контроллера
+				family:	DEVICE_FAMILY_RADIO,
-Контроллер отправляет информацию о своем онлайн/офлайн статусе в топик “out/status”. Формат: {
+				camera_id:	null,
-"status": 1 // см. ниже
+				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"
+		<!--T:414-->
 }
-Поле “status” может принимать следующие значения:
+		},
-• 0 – офлайн
+	},
-• 1 – онлайн
+	error: null,
-• 2 – онлайн, после включения питания
+}
-При получении сообщения со статусом 2, портал должен отправить контроллеру информацию о пользовательских подписках, как это описано в разделе «Подписки».
+</pre>
+== Добавление кода к устройству (set-code-to-device) == <!--T:415-->
-==  Установка подписки на контроллере - “in/subscription/set”: ==
+Запрос:
-{
+<!--T:416-->
-"seq_id": 0,
+Request URL: [site]/api/device/set-code-to-device
-"id": 1, // ID подписки (см. ниже)
-"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
+<!--T:417-->
+Параметры запроса:
+<!--T:418-->
+#token (required): string 64
+#code_id (required): int
+#device_id (required): int
+#name (optional): string 256
+<!--T:422-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	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-->
+Запрос:
+<!--T:424-->
+Request URL: [site]/api/device/remove-code
+Параметры запроса:
+<!--T:425-->
+#token (required): string 64
+#code_id (required): int
+<!--T:427-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	data:	{
+		message: "OK"
+	},
+	error: null
+}
+</pre>
+= События = <!--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>
+{
+	"controller_name": " AS_7F26335CCF4B" ,
+	"device_external_id": 19,
+	"cod_external_id": 1,
+	"device_type": 1,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+}
+</pre>
+<!--T:439-->
+так как MQTT  односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен:
+response:
+Ответ:
+<!--T:441-->
+Пример ответа (data):
+<!--T:442-->
+<pre>
+{
+	"result": "Ok"
+}
+</pre>
+= Места = <!--T:443-->
+== Получение списка мест (places-list) == <!--T:444-->
+Запрос:
+<!--T:445-->
+Request URL: [site]/api/places/places-list
+<!--T:446-->
+Параметры запроса: token (required): string, 64
+<!--T:448-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	"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
+				}
+			]
+		}
+}
+</pre>
+== Создание места (create) == <!--T:449-->
+Запрос:
+<!--T:450-->
+Request URL: [site]/api/places/create
+<!--T:451-->
+Параметры запроса:
+<!--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'
+<!--T:473-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	error:null,
+	data: {'message': 'OK'}
+}
+</pre>
+==  Редактирование места (edit) == <!--T:474-->
+Запрос:
+<!--T:475-->
+Request URL: [site]/api/places/edit
+<!--T:476-->
+Параметры запроса:
+<!--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'
+<!--T:499-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	error:null,
+	data: {'message': 'OK'}
+}
+</pre>
+== Удаление места (delete) == <!--T:501-->
+Запрос:
+<!--T:502-->
+Request URL: [site]/api/places/delete
+<!--T:503-->
+Параметры запроса:
+<!--T:504-->
+#token (required): string, 64
+#place_id (required): int
+<!--T:506-->
+Ответ:
+Пример ответа:
+<pre>
+{
+	error:null,
+	data: {'message': 'OK'}
+}
+</pre>
+== Добавление устройства к месту, смена места у устройства (device-in-place) == <!--T:502-->
+Запрос:
+Request URL: [site]/api/places/device-in-place/
+Параметры запроса:
+#token (required): string 64
+#device_id (required): int
+#place_id (required): int
+#visible (not required): int
+Ответ:
+Пример ответа:
+<pre>
+{
+	data:	{result: "OK"},
+	error: null
+}
+</pre>
+== Отвязать устройство от месту (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."
+		]
+	}
 }
-==  Просмотр статуса подписки: ==
-/api/ctrl/get-subscribe-status
-params:
-token (required): string(64)
-controller_id (required): int
-response: {data:{id: 1, controller_id: 40, user_id: 424, remain_time: 100, request_time: 1355314332, response_time: 1355315332, success: 0}, error: ''}
-==  Активация/продление/покупка подписки: ==
-/api/ctrl/set-subscribe
-params:
-token (required): string(64)
-controller_id (required): int
-response: {data:{id: 1, controller_id: 40, user_id: 424, remain_time: 100, request_time: 1355314332, response_time: 1355315332, success: 0}, error: ''}
-==  Метод получения списка телефонов: ==
-api/ctrl/get-phones
-Params:
-token (required): string, 64
-controller_id (required): int
-type (optional): string, range ['recipient', 'authorized', 'all'], default 'all'
-Response:
-<pre>
-{'error': null, data: [{'id': 5, 'phone': '+380123456789'}, {'id': 6, 'phone': '+380123334455'}, {'id': 7, 'phone': '+380112223344'}]}
-</pre>
-==  Редактирование телефона: ==
-api/ctrl/edit-phone
-Params:
-token (required): string, 64
-phone_id (required): int
-is_recipient (optional): int
-is_authorized (optional): int
-phone (optional): string
-Response:
-<pre>
-{"error":null,"data":{"id":2,"controller_id":81,"phone":"+380503334455","is_recipient":"1","is_authorized":0}}
 </pre>
-==  Удаление телефона: ==
-api/ctrl/delete-phone
+</translate>
-Params:
-token (required): string, 64
-phone_id (required): int
-Response:
-<pre>
-{"error":null,"data":{"response":"OK"}}
-</pre>
-== Добавление телефона: ==
-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>
-{"error":null,"data":{"id":2,"controller_id":81,"phone":"+380503334455","is_recipient":"1","is_authorized":0}}
-</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)