Текущая версия на 16: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."
		]
	}
}

@@ Строка 59: / Строка 59: @@
 <!--T:11-->
 Ответ:
-параметры ответа: (object)
 <!--T:12-->
@@ Строка 85: / Строка 84: @@
 <!--T:15-->
-request:
+Запрос:
 Request URL: [site]/api/registration
 <!--T:16-->
-параметры запроса:
+Параметры запроса:
 <!--T:17-->
-(string) email,
+#(string) email,
+#(string) password
-<!--T:18-->
-(string) password
 <!--T:19-->
@@ Строка 105: / Строка 103: @@
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (object)
-пример:
+Пример ответа (data):
 <pre>
 {
@@ Строка 125: / Строка 123: @@
 <!--T:21-->
-request:
+Запрос:
 <!--T:22-->
@@ Строка 131: / Строка 129: @@
 <!--T:23-->
-параметры запроса: (string) token
+Параметры запроса: (string) token
 <!--T:24-->
@@ Строка 140: / Строка 138: @@
 }
 </pre>
-response:
+Ответ:
-параметры ответа: (object)
-пример:
+Пример ответа (data):
 <pre>
 {
@@ Строка 167: / Строка 165: @@
 <!--T:27-->
-request:
+Запрос:
 Request URL: [site]/api/ctrl/list/
 <!--T:28-->
-параметры запроса: (string) token
+Параметры запроса: (string) token
 <!--T:29-->
@@ Строка 183: / Строка 182: @@
 <!--T:30-->
-response:
+Ответ:
-<!--T:31-->
-параметры ответа: (array)
 <!--T:32-->
-Пример ответа:
+Пример ответа (data):
 <pre>
 {
 "0":{
-	"id":"11",
+	"id": 651,
-	"name":"AS_A61301A020E4",
+	"name": "AE439648F951",
-	"armed":"0",   //0 - снят с охраны, 1 - под охраной
+	"ip": "192.168.10.135",
-	"device_ids":"a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}", //ids устройств на контроллере
+	"fw_id": "1",
-	"action_ids":"a:0:{}", //ids действий на контроллере
+	"hostname": "quadrobase",
-	"timezone":"3",
+	"armed": 0,
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"address": "",
-	"online":"1"
+	"lat": null,
-},
+	"lng": null,
-"1":{
+	"timezone": 2,
-	"id":"12",
+	"online": 1,
-	"name":"AS_A61301A020E5",
+	"last_online": "2019-06-17 19:36:48",
-	"armed":"1",
+	"type_signal": "wifi",
-	"device_ids":"a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}",
+	"wifi_param": -67,
-	"action_ids":"a:0:{}",
+	"gsm_param": 0,
-	"timezone":"2",
+	"phone": "",
-	"token":"734D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"pin": 0,
-	"online":"0"
+	"user_controller_name": "quadrobase",
+	"on_dashboard": 0
 }]
 </pre>
 == Информация о Контроллере (info) == <!--T:33-->
 <!--T:34-->
-request:
+Запрос:
 Request URL: [site]/api/ctrl/info/
 <!--T:35-->
-параметры запроса: (int) controller_id , (string) token
+Параметры запроса:
+#(int) controller_id,
+#(string) token
 <!--T:36-->
@@ Строка 234: / Строка 234: @@
 <!--T:37-->
-response:
+Ответ:
-<!--T:38-->
-параметры ответа: (object)
 <!--T:39-->
-Пример ответа:
+Пример ответа (data):
 <!--T:40-->
@@ Строка 246: / Строка 243: @@
 {
 	"id":"6",
-	"name":"AS_7F26335CCF4B",
+	"name":"66D4E809EF0A",
-	"armed":"1",
+	"hostname":"Test Valera 34",
-	"device_ids":"a:26:{i:0;i:25;i:1;i:26;i:2;i:28;i:3;i:19;i:4;i:40;i:5;i:41;i:6;i:42;i:7;i:43;i:8;i:36;i:9;i:34;i:10;i:29;i:11;i:45;i:12;i:38;i:13;i:33;i:14;i:30;i:15;i:31;i:16;i:49;i:17;i:24;i:18;i:46;i:19;i:47;i:20;i:44;i:21;i:27;i:22;i:22;i:23;i:9;i:24;i:23;i:25;i:7;}",
+	"armed":0,
-	"action_ids":"a:4:{i:0;i:45;i:1;i:46;i:2;i:49;i:3;i:42;}",
+	"address":"",
-	"timezone":"3",
+	"lat":50.4156,
-	"token":"660D91C2B0926A8C981AE7DA4AAA4421A3D86D136262A6F8E98ACF534A7A715B",
+	"lng":30.5336,
-	"online":"1"
+	"ip":"192.168.1.155",
+	"fw_id":1,
+	"timezone":3,
+	"online":1,
+	"last_online":"2019-07-29 17:08:41",
+	"type_signal":"wifi",
+	"wifi_param":-78,
+	"gsm_param":0,
+	"phone":"",
+	"pin":0,
+	"user_controller_name":"Test Valera 34",
+	"on_dashboard":0
 }
 </pre>
@@ Строка 259: / Строка 267: @@
 <!--T:42-->
-request:
+Запрос:
 <!--T:43-->
@@ Строка 265: / Строка 273: @@
 <!--T:44-->
-параметры запроса: (int) controller_id , (string) token
+Параметры запроса:
-пример:
+№(int) controller_id,
+№(string) token
+Пример запроса:
 <!--T:45-->
@@ Строка 275: / Строка 287: @@
 }
 </pre>
-так как MQTT  односторонний - ответа быть не может. Ответ что запрос ушел:
-response:
+Так как MQTT односторонний - ответа быть не может. Ответ что запрос ушел:
-параметры ответа:
-пример:
+Ответ:
+Пример ответа (data):
 <pre>
 {
@@ Строка 289: / Строка 303: @@
 <!--T:47-->
-request:
+Запрос:
 <!--T:48-->
@@ Строка 295: / Строка 309: @@
 <!--T:49-->
-параметры запроса: (string) token
+Параметры запроса: (string) token
 <!--T:50-->
@@ Строка 304: / Строка 318: @@
 }
 </pre>
-response:
-параметры ответа:
+Ответ:
-пример:
+Пример ответа:
 <pre>
 {
@@ Строка 312: / Строка 327: @@
 }
 </pre>
 После ввода пин-кода необходимо обновить список Контроллеров (/api/ctrl/list/)
@@ Строка 317: / Строка 333: @@
 === Этап 1 - обновляем список IDS устройств на Контроллере === <!--T:52-->
-request:
+Запрос:
 <!--T:53-->
 Request URL: [site]/api/ctrl/update/
-параметры запроса: (int) controller_id , (string) token
-пример:
+Параметры запроса:
+#(int) controller_id,
+#(string) token
+Пример запроса:
 <pre>
 {
@@ Строка 329: / Строка 350: @@
 }
 </pre>
-response:
-параметры ответа:
+Ответ:
-пример:
+Пример ответа (data):
 <pre>
 {
-	"result": "Ok" // "Ok" = запрос ушел
+	"result": "Ok" // "Ok" = запрос отправлен
 }
 </pre>
@@ Строка 341: / Строка 363: @@
 <!--T:55-->
-request:
+Запрос:
 Request URL: [site]/api/ctrl/update-devices/
 <!--T:56-->
-параметры запроса:
+Параметры запроса:
 <!--T:57-->
-(int) controller_id,
+#(int) controller_id,
-(string) token
+#(string) token
 <!--T:58-->
@@ Строка 361: / Строка 384: @@
 <!--T:59-->
-response:
+Ответ:
-<!--T:60-->
-параметры ответа:
 <!--T:61-->
 Пример ответа:
 <pre>
 {
-	"result": "Ok" // ответ что запрос ушел
+	"result": "Ok" // Запрос отправлен
 }
 </pre>
 Процесс происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (контроллер, устройства)
 == Удаление Контроллера (delete) == <!--T:62-->
+Запрос:
 <!--T:63-->
 Request URL: [site]/api/ctrl/delete
-<!--T:64-->
-Параметры запроса:
 <!--T:65-->
@@ Строка 395: / Строка 416: @@
 <!--T:66-->
-response:
+Ответ:
-параметры ответа:
-пример:
+Пример ответа:
 <pre>
 {
 	"error":null,
-	"data":{"resuls":"Ok"}
+	"data":{"result":"Ok"}
 }
 </pre>
@@ Строка 408: / Строка 430: @@
 <!--T:68-->
-request:
+Запрос:
 <!--T:69-->
-Request URL: [site]/api/ ctrl/update-status/
+Request URL: [site]/api/ctrl/update-status/
 <!--T:70-->
 Параметры запроса:
-<!--T:71-->
+#(string) token,
-(string) token,
+#(int) controller_id
-<!--T:72-->
-(int) controller_id
 <!--T:73-->
 Пример запроса:
 <pre>
 {
@@ Строка 432: / Строка 452: @@
 <!--T:74-->
-response:
+Ответ:
-<!--T:75-->
-параметры ответа:
 <!--T:76-->
 Пример ответа:
 <pre>
 {
 	"error":null,
 	"data":{
-		"resuls":"Ok"
+		"result":"Ok"
 		}
 }
@@ Строка 449: / Строка 467: @@
 == Получение актуального статуса Контроллера (get-status) ==  <!--T:77-->
-request:
+Запрос:
 <!--T:78-->
-Request URL: [site]/api/ ctrl/get-status/
+Request URL: [site]/api/ctrl/get-status/
 <!--T:79-->
-параметры запроса:
+Параметры запроса:
-<!--T:80-->
-(string) token,
-<!--T:81-->
+#(string) token,
-(int) controller_id
+#(int) controller_id
 <!--T:82-->
 Пример запроса:
 <pre>
 {
@@ Строка 473: / Строка 490: @@
 <!--T:83-->
-response:
+Ответ:
-<!--T:84-->
-параметры ответа:
 <!--T:85-->
 Пример ответа:
 <pre>
 {
@@ Строка 499: / Строка 514: @@
 • 2 – онлайн, после включения питания
-==  Передача локального IP Контроллера (get-ip) == <!--T:89-->
+== Получение конфигурации Контроллера (config) == <!--T:89-->
-<!--T:90-->
+<!--T:82-->
-Request URL: [site]/api/ctrl/get-ip
+Запрос:
-<!--T:91-->
+Request URL: [site]/api/ctrl/config/
-Request Params:
-<!--T:92-->
+<!--T:82-->
-token (required): string(64);
+Параметры запроса:
-<!--T:93-->
+#(string) token,
-controller_id (required): int;
+#(int) controller_id
-<!--T:94-->
+<!--T:82-->
-SUCCESS RESPONSE:
+Пример запроса:
-<!--T:95-->
 <pre>
 {
-	data:'192.168.0.15',
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	error: null
+	"controller_id" : 111
 }
 </pre>
-== Установка подписки на Контроллере == <!--T:96-->
+<!--T:82-->
-in/subscription/set
+Ответ:
+<!--T:82-->
+Пример ответа (data):
-<!--T:97-->
-Request URL: [site]/in/subscription/set”
 <pre>
 {
-	"seq_id": 0,
+	"id":"1",   // id конфигурации
-	"id": 1, // ID подписки (см. ниже)
+	"controller_id":"111",   // id контроллера
-	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
+	"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>
-==  Просмотр статуса подписки (get-subscribe-status) == <!--T:98-->
-<!--T:99-->
+== Изменение конфигурации контроллера(config-set) == <!--T:89-->
-Request URL: [site]/api/ctrl/get-subscribe-status
-<!--T:100-->
+<!--T:89-->
-params:
+Запрос:
-<!--T:101-->
+Request URL: [site]/api/ctrl/config-set/
-token (required): string(64)
-<!--T:102-->
+<!--T:89-->
-controller_id (required): int
+Параметры запроса:
-<!--T:103-->
+#(string) token,
-response:
+#(int) controller_id
-<!--T:104-->
+<!--T:89-->
-{data:{id: 1, controller_id: 40, user_id: 424, remain_time: 100, request_time: 1355314332, response_time: 1355315332, success: 0}, error: ''}
+Пример запроса:
+<pre>
+{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"controller_id" : 111,
+	"command": "yyy"    // параметры контроллера смотри метод Получить конфигурацию контроллера(ctrl/config/)
+}
+</pre>
-==  Активация/продление/покупка подписки (set-subscribe) == <!--T:105-->
+<!--T:89-->
+Ответ:
-<!--T:106-->
-Request URL: [site]/api/ctrl/set-subscribe
-<!--T:107-->
-params:
-<!--T:108-->
-token (required): string(64)
-<!--T:109-->
+<!--T:89-->
-controller_id (required): int
+Пример ответа (data):
-<!--T:110-->
-response:
 <pre>
 {
-	data:{
+	"result": "Ok"
-		id: 1,
-		controller_id: 40,
-		user_id: 424,
-		remain_time: 100,
-		request_time: 1355314332,
-		response_time: 1355315332,
-		success: 0
-	},
-	error: ''
 }
 </pre>
+==  Передача локального IP Контроллера (get-ip) == <!--T:89-->
-==  Метод получения списка телефонов (get-phones) == <!--T:111-->
+Запрос
-<!--T:112-->
+<!--T:90-->
-Request URL: [site]/api/ctrl/get-phones
+Request URL: [site]/api/ctrl/get-ip
-<!--T:113-->
+<!--T:91-->
-Params:
+Request Params:
-<!--T:114-->
+#token (required): string(64);
-token (required): string, 64
+#controller_id (required): int;
-<!--T:115-->
+Ответ:
-controller_id (required): int
+<!--T:94-->
-<!--T:116-->
+Пример ответа:
-type (optional): string,
-range ['recipient', 'authorized', 'all'], default 'all'
-<!--T:117-->
+<!--T:95-->
-Response:
-<!--T:118-->
 <pre>
 {
-	'error': null,
+	data:'192.168.0.15',
-	data: [
+	error: null
-		{'id': 5, 'phone': '+380123456789'},
-		{'id': 6, 'phone': '+380123334455'},
-		{'id': 7, 'phone': '+380112223344'}
-	]
 }
 </pre>
+== Установка подписки на Контроллере == <!--T:96-->
-==  Редактирование телефона (edit-phone) == <!--T:119-->
+Запрос:
-<!--T:120-->
+<!--T:97-->
-Request URL: [site]/api/ctrl/edit-phone
+Request URL: [site]/in/subscription/set”
-<!--T:121-->
+Ответ:
-Params:
-<!--T:122-->
-token (required): string, 64
-<!--T:123-->
-phone_id (required): int
-<!--T:124-->
-is_recipient (optional): int
-<!--T:125-->
-is_authorized (optional): int
-<!--T:126-->
+Пример ответа (data):
-phone (optional): string
-<!--T:127-->
-Response:
 <pre>
 {
-	"error":null,
+	"seq_id": 0,
-	"data":{
+	"id": 1, // ID подписки (см. ниже)
-		"id":2,
+	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
-		"controller_id":81,
-		"phone":"+380503334455",
-		"is_recipient":"1",
-		"is_authorized":0
-	}
 }
 </pre>
+==  Просмотр статуса подписки (get-subscribe-status) == <!--T:98-->
+Запрос:
-==  Удаление телефона (delete-phone) == <!--T:128-->
+<!--T:99-->
+Request URL: [site]/api/ctrl/get-subscribe-status
-<!--T:129-->
+<!--T:100-->
-Request URL: [site]/api/ctrl/delete-phone
+Параметры:
-<!--T:130-->
+<!--T:101-->
-Params:
+#token (required): string(64)
+#controller_id (required): int
-<!--T:131-->
+<!--T:103-->
-token (required): string, 64
+Ответ:
-<!--T:132-->
+Пример ответа (data):
-phone_id (required): int
-<!--T:133-->
+<!--T:104-->
-Response:
 <pre>
 {
-	"error":null,
+	data:{
-	"data":{"response":"OK"}
+		id: 1,
+		controller_id: 40,
+		user_id: 424,
+		remain_time: 100,
+		request_time: 1355314332,
+		response_time: 1355315332,
+		success: 0
+	},
+	error: ''
 }
 </pre>
-== Добавление телефона (add-phone) == <!--T:134-->
+==  Активация/продление/покупка подписки (set-subscribe) == <!--T:105-->
-<!--T:135-->
+Запрос:
-Request URL: [site]/api/ctrl/add-phone
-<!--T:136-->
+<!--T:106-->
-Params:
+Request URL: [site]/api/ctrl/set-subscribe
-<!--T:137-->
+<!--T:107-->
-token (required): string, 64
+Параметры:
-<!--T:138-->
+<!--T:108-->
-controller_id (required): int
+#token (required): string(64)
+#controller_id (required): int
-<!--T:139-->
+<!--T:110-->
-phone (required): string
+Ответ:
-<!--T:140-->
-is_recipient (optional): int
-<!--T:141-->
-is_authorized (optional): int
-<!--T:142-->
-Response:
-<!--T:143-->
 <pre>
 {
-	"error":null,
+	data:{
-	"data":{
+		id: 1,
-		"id":2,
+		controller_id: 40,
-		"controller_id":81,
+		user_id: 424,
-		"phone":"+380503334455",
+		remain_time: 100,
-		"is_recipient":"1",
+		request_time: 1355314332,
-		"is_authorized":0
+		response_time: 1355315332,
-	}
+		success: 0
+	},
+	error: ''
 }
 </pre>
-= Устройства = <!--T:144-->
+==  Метод получения списка телефонов (get-phones) == <!--T:111-->
-== Получение списка устройств пользователя (list) == <!--T:145-->
+Запрос:
-<!--T:146-->
+<!--T:112-->
-request:
+Request URL: [site]/api/ctrl/get-phones
-<!--T:147-->
+<!--T:113-->
-Request URL: [site]/api/device/list
+Параметры:
-<!--T:148-->
+<!--T:114-->
-параметры запроса: (int) controller_id , (string) token
+#token (required): string, 64
+#controller_id (required): int
+#type (optional): string,
+#range ['recipient', 'authorized', 'all'], (default: 'all')
-<!--T:149-->
+<!--T:117-->
-Пример запроса:
+Ответ:
+Пример ответа:
+<!--T:118-->
 <pre>
 {
-	"controller_id": 1 ,
+	'error': null,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	data: [
+		{'id': 5, 'phone': '+380123456789'},
+		{'id': 6, 'phone': '+380123334455'},
+		{'id': 7, 'phone': '+380112223344'}
+	]
 }
 </pre>
-<!--T:150-->
-response:
+==  Редактирование телефона (edit-phone) == <!--T:119-->
-параметры ответа:
+Запрос:
-Пример ответа:
+<!--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>
 {
-"0":{
+	"error":null,
-	"id":"122",
+	"data":{
-	"external_id":"19", //id на контроллере
+		"id":2,
-	"controller_id":"6",
+		"controller_id":81,
-	"name":"Сирена",
+		"phone":"+380503334455",
-	"type_id":"2",  //тип устройства
+		"is_recipient":"1",
-	"codes":":{     //коды (кнопки)
+		"is_authorized":0
-		"0":{
+	}
-		"id":"218",
+}
-		"external_cod_id":"32",
+</pre>
-		"device_id":"122",
-		"name":"ON",
-		"code":"3675192",
+==  Удаление телефона (delete-phone) == <!--T:128-->
-		"protocol":"1",
-		"pulse_len":null,
+Запрос:
-		"group_1":"1",
-		"group_2":"0",
+<!--T:129-->
-		"group_3":"0",
+Request URL: [site]/api/ctrl/delete-phone
-		"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"
-}
-}
-</pre>
+<!--T:130-->
+Параметры:
-== Информация об устройстве (info) == <!--T:151-->
+<!--T:131-->
+#token (required): string, 64
+#phone_id (required): int
-<!--T:152-->
+<!--T:133-->
-request:
+Ответ:
-<!--T:153-->
+Пример ответа:
-Request URL: [site]/api/device/info/
-<!--T:154-->
-параметры запроса:
-<!--T:155-->
-(int) controller_id,
-<!--T:156-->
-(int) device_id,
-<!--T:157-->
-(string) token
-<!--T:158-->
-Пример запроса:
 <pre>
 {
-	"controller_id": 1 ,
+	"error":null,
-	"device_id": 122,
+	"data":{"response":"OK"}
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-<!--T:159-->
+== Добавление телефона (add-phone) == <!--T:134-->
-response:
+Запрос:
+<!--T:135-->
+Request URL: [site]/api/ctrl/add-phone
+<!--T:136-->
+Params:
-<!--T:160-->
+<!--T:137-->
-параметры ответа:
+#token (required): string, 64
+#controller_id (required): int
-Пример ответа:
+#phone (required): string
-<pre>
+#is_recipient (optional): int
+#is_authorized (optional): int
+<!--T:142-->
+Ответ:
+Пример ответа:
+<!--T:143-->
+<pre>
 {
-	"id":"122",
+	"error":null,
-	"external_id":"19",
+	"data":{
-	"controller_id":"6",
+		"id":2,
-	"name":"Сирена",
+		"controller_id":81,
-	"type_id":"2",
+		"phone":"+380503334455",
-	"codes":{
+		"is_recipient":"1",
-		"0":{
+		"is_authorized":0
-		"id":"218",
+	}
-		"external_cod_id":"32",
+}
-		"device_id":"122",
+</pre>
-		"name":"ON",
-		"code":"3675192",
+== Информация о версии прошивки контроллера (fw-version-current) == <!--T:145-->
-		"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"
-}
-</pre>
+Request URL: [site]/api/ctrl/fw-version-current/
-== Обновление информации об устройстве (update) == <!--T:161-->
+Параметры запроса:
-<!--T:162-->
+#(int) controller_id,
-request:
+#(string) token
-<!--T:163-->
+Пример запроса:
-Request URL: [site]/api/device/update/
-<!--T:164-->
+<pre>
-параметры запроса:
+{
+	"controller_id": 1 ,
-<!--T:165-->
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-(int) device_id,
+}
+</pre>
+Ответ:
+Пример ответа (data):
+<pre>
+{
+	"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" значит имеется новая версия.
+}
+</pre>
+== Информация о последней версии прошивки контроллера (get-new-fw-version) == <!--T:145-->
+Запрос:
-<!--T:166-->
+Request URL: [site]/api/ctrl/get-new-fw-version/
-(string) name,
-<!--T:167-->
+Параметры запроса:
-(int) active,
-<!--T:168-->
+#(int) controller_id,
-(string) token,
+#(string) token
-<!--T:169-->
-Пример запроса:
 <pre>
+Пример запроса:
 {
-	"device_id": 107,   // local device id
+	"controller_id": 1 ,
-	"name": "New name", // new name
-	"active": 1,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-response:
-<!--T:170-->
+Ответ:
-параметры ответа:
+Пример ответа (data):
-Пример ответа:
 <pre>
 {
-	"resuls" : "Ok"
+	"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>
-== Удаление устройства (delete) == <!--T:171-->
+= Устройства = <!--T:144-->
-<!--T:172-->
+== Получение списка устройств пользователя (list) == <!--T:145-->
-request:
-<!--T:173-->
+<!--T:146-->
-Request URL: [site]/api/device/delete/
+Запрос:
-<!--T:174-->
+<!--T:147-->
-параметры запроса:
+Request URL: [site]/api/device/list
-<!--T:175-->
+<!--T:148-->
-(int) device_id,
+Параметры запроса:
-<!--T:176-->
+#(int) controller_id,
-(string) token
+#(string) token
-<!--T:177-->
+<!--T:149-->
 Пример запроса:
 <pre>
 {
-	"device_id": 107,   // local device id
+	"controller_id": 1 ,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-<!--T:178-->
+<!--T:150-->
-response:
+Ответ:
-<!--T:179-->
+Пример ответа (data):
-Параметры ответа:
-<!--T:180-->
-Пример ответа:
 <pre>
 {
-	"resuls" : "Ok"
+"0":{
+	"id":"122",
-<!--T:181-->
+	"external_id":"19", //id на контроллере
-}
+	"controller_id":"6",
-</pre>
+	"name":"Сирена",
+	"type_id":"2",  //тип устройства
+	"codes":":{     //коды (кнопки)
-== Получение метеоданных (last) == <!--T:182-->
+		"0":{
+		"id":"218",
-<!--T:183-->
+		"external_cod_id":"32",
-request:
+		"device_id":"122",
-Request URL: [site]/api/device/meteo-last/
+		"name":"ON",
+		"code":"3675192",
-<!--T:184-->
+		"protocol":"1",
-параметры запроса:
+		"pulse_len":null,
+		"group_1":"1",
-<!--T:185-->
+		"group_2":"0",
-(string) token,
+		"group_3":"0",
+		"group_4":"0",
-<!--T:186-->
+		"group_5":"0",
-(int) device_id
+		"group_6":"0",
+		"group_7":"0",
-<!--T:187-->
+		"group_8":"0",
-Пример запроса:
+		"active":"1"
-<pre>
+		},
-{
+		"1":{ ... }
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	},
-	"device_id": 130
+	"state":"1",
-}
+	"on_dashboard":"1", //показывать на главной
-</pre>
+	"active":"1"
-response:
+},
+"1":{
+	"id":"120",
+	"external_id":"22",
+	"controller_id":"6",
+	"name":"Пульт 4кн бел",
+	"type_id":"3",
+	"codes": ... ,
+	"state":"1",
+	"on_dashboard":"0",
+	"active":"1"
+	}
+}
+</pre>
-<!--T:188-->
-параметры ответа: (object)
-<!--T:189-->
+== Информация об устройстве (info) == <!--T:151-->
-Пример ответа:
+<!--T:152-->
+Запрос:
+<!--T:153-->
+Request URL: [site]/api/device/info/
+<!--T:154-->
+Параметры запроса:
+<!--T:155-->
+#(int) controller_id,
+#(int) device_id,
+#(string) token
-<!--T:190-->
+<!--T:158-->
+Пример запроса:
 <pre>
 {
-	"id":"4046",
+	"controller_id": 1 ,
-	"controller_name":"AS_7FD6785CCF5D",
+	"device_id": 122,
-	"internal_id":"55",
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-	"device_id":"130",
-	"name":"7",
-	"temp":"240",
-	"hum":"245",
-	"illum":"0",
-	"pres":"1239",
-	"volt":"32",
-	"date_time":"2016-03-02 21:09:40",
-	"new":"0"
 }
 </pre>
-== Получение метеоданных за период (period) == <!--T:191-->
+<!--T:159-->
-request:
+Ответ:
+Пример ответа (data):
+<pre>
+{
+	"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
+		}
+}
+</pre>
-<!--T:192-->
+== Обновление информации об устройстве (update) == <!--T:161-->
-Request URL: [site]/api/device/meteo-period/
-<!--T:193-->
+<!--T:162-->
-параметры запроса:
+Запрос:
-<!--T:194-->
+<!--T:163-->
-(string) token,
+Request URL: [site]/api/device/update/
-<!--T:195-->
+<!--T:164-->
-(int) device_id,
+Параметры запроса:
-<!--T:196-->
+<!--T:165-->
-(int) period
+#(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"
+}
+</pre>
+Ответ:
+Пример ответа (data):
-<!--T:197-->
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"result" : "Ok"
-	"device_id": 130,
-	"period": 1 // количество дней
 }
 </pre>
-<!--T:198-->
+== Удаление устройства (delete) == <!--T:171-->
-response:
-<!--T:199-->
+<!--T:172-->
-параметры ответа: (array to objects)
+Запрос:
-<!--T:200-->
+<!--T:173-->
-Пример ответа:
+Request URL: [site]/api/device/delete/
-<pre>
-[
-	{
-	"id":"4065",
-	"controller_name":"AS_7FD6785CCF5D",
-	"internal_id":"55",
-	"device_id":"130",
-	"name":"7",
-	"temp":"240",
-	"hum":"523",
-	"illum":"0",
-	"pres":"1239",
-	"volt":"32",
-	"date_time":"2017-07-30 21:11:07",
-	"new":"0"
-	},
-	{
-	"id":"4067",
-	"controller_name":"AS_7FD6785CCF5D
-	...
-	},
-]
-</pre>
-== Получение данных электропитания (last) == <!--T:201-->
+<!--T:174-->
+Параметры запроса:
-request:
-Request URL: [site]/api/device/electro-last/
-<!--T:202-->
+<!--T:175-->
-параметры запроса:
+#(int) device_id,
+#(string) token
-<!--T:203-->
+<!--T:177-->
-(string) token,
+Пример запроса:
-<!--T:204-->
-(int) device_id
-<!--T:205-->
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"device_id": 107,   // local device id
-	"device_id": 130
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-<!--T:206-->
+<!--T:178-->
-response:
+Ответ:
-<!--T:207-->
+<!--T:180-->
-параметры ответа: (object)
+Пример ответа (data):
-<!--T:208-->
-Пример ответа:
-<!--T:209-->
 <pre>
 {
-	"id":"318",
+	"result" : "Ok"
-	"controller_id":"11",
-	"external_id":"2",
-	"device_id":"125",
-	"name":"23",
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
-	"last_seen":"2017-07-21 04:20:27",
-	"available":"1",
-	"voltage":"24",
-	"have_voltage":"1",
-	"current":"2147483647",
-	"have_current":"1",
-	"supp_voltage":"33",
-	"date_create":"2017-07-21 01:20:33",
-	"new":"0"
 }
 </pre>
-== Получение данных электропитания за период (period) == <!--T:210-->
+== Получение метеоданных (last) == <!--T:182-->
-request:
-<!--T:211-->
+<!--T:183-->
-Request URL: [site]/api/device/electro-period/
+Запрос:
-<!--T:212-->
+Request URL: [site]/api/device/meteo-last/
-параметры запроса:
-<!--T:213-->
+<!--T:184-->
-(string) token,
+Параметры запроса:
-<!--T:214-->
+<!--T:185-->
-(int) device_id,
+#(string) token,
+#(int) device_id
-<!--T:215-->
+<!--T:187-->
-(int) period
+Пример запроса:
-<!--T:216-->
-Пример запроса:
 <pre>
 {
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"device_id": 130,
+	"device_id": 130
-	"period": 1 // количество дней
 }
 </pre>
-response:
-<!--T:217-->
+Ответ:
-параметры ответа: (array to objects)
+<!--T:189-->
+Пример ответа (data):
-<!--T:218-->
+<!--T:190-->
-Пример ответа:
 <pre>
-[
+{
-	{
+	"id":"4046",
-	"id":"318",
+	"controller_name":"AS_7FD6785CCF5D",
-	"controller_id":"11",
+	"internal_id":"55",
-	"external_id":"2",
+	"device_id":"130",
-	"device_id":"125",
+	"name":"7",
-	"name":"23",
+	"temp":"240",
-	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"hum":"245",
-	"last_seen":"2017-07-21 04:20:27",
+	"illum":"0",
-	"available":"1",
+	"pres":"1239",
-	"voltage":"24",
+	"volt":"32",
-	"have_voltage":"1",
+	"date_time":"2016-03-02 21:09:40",
-	"current":"2147483647",
+	"new":"0"
-	"have_current":"1",
+}
-	"supp_voltage":"33",
+</pre>
-	"date_create":"2017-07-21 01:20:33",
-	"new":"0"
+== Получение метеоданных за период (period) == <!--T:191-->
-	},
-	{
+Запрос:
-	"id":"318",
-	"controller_id":"11",
-	...
-	},
-]
-</pre>
-== Получение данных о сторонних устройствах (other-last) == <!--T:219-->
+<!--T:192-->
+Request URL: [site]/api/device/meteo-period/
-<!--T:220-->
+<!--T:193-->
-Метод возвращает информацию о последнем обнаруженном стороннем устройстве.
-request:
-<!--T:221-->
-Request URL: [site]/api/device/other-last/
-<!--T:222-->
 Параметры запроса:
-<!--T:223-->
+<!--T:194-->
-(string) token,
+#(string) token,
+(int) device_id,
+#(int) period
-<!--T:224-->
+<!--T:197-->
-(int) device_id
+Пример запроса:
-<!--T:225-->
-Пример запроса:
 <pre>
 {
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"device_id": 118
+	"device_id": 130,
+	"period": 1 // количество дней
 }
 </pre>
-response:
-<!--T:226-->
+<!--T:198-->
-параметры ответа: (object)
+Ответ:
-<!--T:227-->
+<!--T:199-->
-Пример ответа:
+параметры ответа (array to objects):
-<pre>
-{
-	"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"
-}
-</pre>
+<!--T:200-->
+Пример ответа (data):
-== Получение данных о сторонних устройствах за период (other-period) == <!--T:228-->
+<pre>
-request:
+[
+	{
-<!--T:229-->
+	"id":"4065",
-Request URL: [site]/api/device/other-period/
+	"controller_name":"AS_7FD6785CCF5D",
+	"internal_id":"55",
+	"device_id":"130",
+	"name":"7",
+	"temp":"240",
+	"hum":"523",
+	"illum":"0",
+	"pres":"1239",
+	"volt":"32",
+	"date_time":"2017-07-30 21:11:07",
+	"new":"0"
+	},
+	{
+	"id":"4067",
+	"controller_name":"AS_7FD6785CCF5D
+	...
+	},
+]
+</pre>
-<!--T:230-->
+== Получение данных электропитания (last) == <!--T:201-->
-параметры запроса:
+Запрос:
-<!--T:231-->
+Request URL: [site]/api/device/electro-last/
-(string) token,
-<!--T:232-->
+<!--T:202-->
-(int) device_id,
+Параметры запроса:
-<!--T:233-->
+<!--T:203-->
-(int) period
+#(string) token,
+#(int) device_id
-<!--T:234-->
+<!--T:205-->
 Пример запроса:
+<pre>
 {
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-	"device_id": 118,
+	"device_id": 130
-	"period": 1 // количество дней
 }
-response:
+</pre>
+<!--T:206-->
+Ответ:
-<!--T:235-->
+<!--T:208-->
-параметры ответа: (array to objects)
+Пример ответа (data):
-<!--T:236-->
+<!--T:209-->
-Пример ответа:
 <pre>
 {
-	"id":"1301",
+	"id":"318",
-	"controller_id":"6",
+	"controller_id":"11",
-	"device_id":"118",
+	"external_id":"2",
-	"name":"Розетка",
+	"device_id":"125",
-	"code":"81",
+	"name":"23",
-	"pulse_len":null,
+	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
-	"bit_len":null,
+	"last_seen":"2017-07-21 04:20:27",
-	"protocol":null,
+	"available":"1",
-	"groups":null,
+	"voltage":"24",
-	"type":null,
+	"have_voltage":"1",
-	"date_time":"2017-08-21 04:55:18",
+	"current":"2147483647",
-	"active":null,
+	"have_current":"1",
-	"new":"1"
+	"supp_voltage":"33",
-	},
+	"date_create":"2017-07-21 01:20:33",
-	{
+	"new":"0"
-	"id":"4067",
-	"controller_id":"6",
-	...
 }
 </pre>
-= Wizard добавления устройств  = <!--T:237-->
+== Получение данных электропитания за период (period) == <!--T:210-->
+Запрос:
+<!--T:211-->
+Request URL: [site]/api/device/electro-period/
-== Датчик открытия двери (create-door-open-sensor) == <!--T:238-->
+<!--T:212-->
+Параметры запроса:
-<!--T:239-->
+<!--T:213-->
-URL:  [site]/api/wizard/create-door-open-sensor
+#(string) token,
+#(int) device_id,
+#(int) period
-<!--T:240-->
+<!--T:216-->
-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 //Название кода садящейся батареи
-<!--T:241-->
-RESPONSE:
 <pre>
 {
-	data:{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		'response': 'OK'
+	"device_id": 130,
-		},
+	"period": 1 // количество дней
-	error: null
 }
 </pre>
-<!--T:242-->
+Ответ:
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+<!--T:217-->
+Параметры ответа: (array to objects)
-==  Датчик затопления (create-flood-sensor) == <!--T:243-->
+<!--T:218-->
+Пример ответа (data):
-<!--T:244-->
-Request URL: [site]/api/wizard/create-flood-sensor
-<!--T:245-->
-Params:
-<!--T:246-->
-controller_id (required): int
-<!--T:247-->
-token (required): string, 64
-<!--T:248-->
-device_name (optional): string, 256
-code_alarm (optional): string, 64 //Название кода оповещения
-<!--T:249-->
-code_tamper (optional): string, 64 //Название кода вмешательства
-<!--T:250-->
-code_low_battery (optional): string, 64 //Название кода садящейся батареи
-<!--T:251-->
-RESPONSE:
 <pre>
-{
+[
-	data: {
+	{
-		'response': 'OK'
+	"id":"318",
-		},
+	"controller_id":"11",
-	error: null
+	"external_id":"2",
-}
+	"device_id":"125",
+	"name":"23",
+	"token":"747D3844ABD35B08F27D18D15D7178B7AF99A754D805633928D4362D19B4AEC2",
+	"last_seen":"2017-07-21 04:20:27",
+	"available":"1",
+	"voltage":"24",
+	"have_voltage":"1",
+	"current":"2147483647",
+	"have_current":"1",
+	"supp_voltage":"33",
+	"date_create":"2017-07-21 01:20:33",
+	"new":"0"
+	},
+	{
+	"id":"318",
+	"controller_id":"11",
+	...
+	},
+]
 </pre>
----------------------------------------
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+== Получение данных о сторонних устройствах (other-last) == <!--T:219-->
-== Пульт,4 кнопки (create-console) == <!--T:252-->
+<!--T:220-->
+Метод возвращает информацию о последнем обнаруженном стороннем устройстве.
+Запрос:
-<!--T:253-->
+<!--T:221-->
-Request URL: [site]/api/wizard/create-console
+Request URL: [site]/api/device/other-last/
-<!--T:254-->
+<!--T:222-->
-Params:
+Параметры запроса:
-<!--T:255-->
+<!--T:223-->
-controller_id (required): int
+#(string) token,
+#(int) device_id
-<!--T:256-->
+<!--T:225-->
-token (required): string, 64
+Пример запроса:
-<!--T:257-->
-device_name (optional): string, 256
-<!--T:258-->
-code_lock (optional): string, 64 //Название кода блокировки
-<!--T:259-->
-code_unlock (optional): string, 64 //Название кода разблокировки
-<!--T:260-->
-code_s (optional): string, 64 //Название кода s
-<!--T:261-->
-code_alarm (optional): string, 64 //Название кода оповещения
-<!--T:262-->
-RESPONSE:
 <pre>
 {
-	data: {
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		'response': 'OK'
+	"device_id": 118
-	},
-	error: null
 }
 </pre>
----------------------------------------
-После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+Ответ:
-== Сирена (create-siren) == <!--T:263-->
+<!--T:227-->
+Пример ответа (data):
+<pre>
+{
+	"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"
+}
+</pre>
-<!--T:264-->
-Request URL: [site]/api/wizard/create-siren
-<!--T:265-->
+== Получение данных о сторонних устройствах за период (other-period) == <!--T:228-->
-Params:
-<!--T:266-->
+Запрос:
-controller_id (required): int
-<!--T:267-->
+<!--T:229-->
-token (required): string, 64
+Request URL: [site]/api/device/other-period/
-<!--T:268-->
+<!--T:230-->
-device_name (optional): string, 256
+Параметры запроса:
-<!--T:269-->
+<!--T:231-->
-code_on (optional): string, 64 //Название кода включения
+#(string) token,
+#(int) device_id,
+#(int) period
-<!--T:270-->
+<!--T:234-->
-code_off (optional): string, 64 //Название кода выключения
+Пример запроса:
-<!--T:271-->
+<pre>
-code_blank (optional): string, 64 //Название кода blank
-<!--T:272-->
-RESPONSE:
-<pre>
 {
-	data: {
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		'response': 'OK'
+	"device_id": 118,
-		},
+	"period": 1 // количество дней
-	error: null
 }
 </pre>
----------------------------------------
-Перед отправкой параметров необходимо перевести сирену в режим обучения.
+Ответ:
-== Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos) == <!--T:273-->
+<!--T:236-->
-Request URL: [site]/api/wizard/get-meteos
+Пример ответа (data):
-<!--T:274-->
-Params:
-<!--T:275-->
-controller_id (required): int
-<!--T:276-->
-token (required): string, 64
-<!--T:277-->
-RESPONSE:
 <pre>
 {
-	"error":null,
+	"id":"1301",
-	"data":				 	[{"id":"93","controller_id":"79","date":"1528389351","type":"7","family":"0","rf_code":null,"rf_bit_len":null,"rf_pulse_len":null,"rf_protocol":null,"rf_freq":null,"ir_code":null,"ir_bit_len":null,"ir_address":null,"ir_protocol":null,"meteo_num":"0"}]
+	"controller_id":"6",
-}
+	"device_id":"118",
-</pre>
+	"name":"Розетка",
+	"code":"81",
-== Метеостанция: добавление (create-meteo) == <!--T:278-->
+	"pulse_len":null,
+	"bit_len":null,
+	"protocol":null,
+	"groups":null,
+	"type":null,
+	"date_time":"2017-08-21 04:55:18",
+	"active":null,
+	"new":"1"
+	},
+	{
+	"id":"4067",
+	"controller_id":"6",
+	...
+}
+</pre>
+= Wizard добавления устройств  = <!--T:237-->
-<!--T:279-->
-Request URL: [site][site]/api/wizard/create-meteo
-<!--T:280-->
+== Датчик открытия двери (create-door-open-sensor) == <!--T:238-->
-Params:
-<!--T:281-->
+Запрос:
-controller_id (required): int
-<!--T:282-->
+<!--T:239-->
-token (required): string, 64
+URL:  [site]/api/wizard/create-door-open-sensor
-<!--T:283-->
+<!--T:240-->
-meteo_num (required): int //Получается в списке выше
+Параметры запроса:
-<!--T:284-->
+#controller_id (required): int
-device_name (optional): string, 256
+#token (required): string, 64
+#device_name (optional): string, 256
+#code_ready (optional): string, 64 //Название кода готовности
+#code_alarm (optional): string, 64 //Название кода оповещания
+#code_low_battery (optional): string, 64 //Название кода садящейся батареи
-<!--T:285-->
+<!--T:241-->
-RESPONSE:
+Ответ:
-<pre>
+Пример ответа:
+<pre>
 {
-	"error":null,
+	data:{
-	"data":{
+		'response': 'OK'
-		"response":"OK"
+		},
-		}
+	error: null
 }
 </pre>
+<!--T:242-->
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
+==  Датчик затопления (create-flood-sensor) == <!--T:243-->
-== Водопроводный кран == <!--T:286-->
+Запрос:
-<!--T:287-->
+<!--T:244-->
-Порядок добавления крана:
+Request URL: [site]/api/wizard/create-flood-sensor
-) Сгенерировать коды
-<!--T:288-->
+<!--T:245-->
-) Зажать на кране кнопку, пока кран не мигнёт трижды
+Параметры запроса:
-<!--T:289-->
+<!--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:290-->
+<!--T:251-->
-) Нажать на кране кнопку однократно
+Ответ:
-<!--T:291-->
+Пример ответа:
-) Зажать на кране кнопку, пока не мигнёт 4 раза
+<pre>
+{
+	data: {
+		'response': 'OK'
+		},
+	error: null
+}
+</pre>
-<!--T:292-->
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-) Отправить второй код из сгенерированных
-<!--T:293-->
-) Нажать на кране кнопку однократно
-<!--T:294-->
+== Пульт,4 кнопки (create-console) == <!--T:252-->
-) Отправить запрос на создание крана.
+Запрос:
-=== Генерация кодов === <!--T:295-->
+<!--T:253-->
+Request URL: [site]/api/wizard/create-console
-<!--T:296-->
+<!--T:254-->
-Request URL: [site]/api/wizard/create-codes
+Параметры запроса:
-<!--T:297-->
+<!--T:255-->
-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 //Название кода оповещения
-<!--T:298-->
+<!--T:262-->
-controller_id (required): int
+Ответ:
-<!--T:299-->
+Пример ответа:
-token (required): string, 64
-<!--T:300-->
-Response:
 <pre>
 {
-	"error":null,
+	data: {
-	"data":{"response":{"id":30,"masks":"[6,4,0,1]","code_1":"9920950","code_2":"9920948","code_3":"9920944","code_4":"9920945"}
+		'response': 'OK'
-		}
+	},
+	error: null
 }
 </pre>
+После отправки параметров ожидается срабатывание добавляемого устройства. При срабатывании происходит процесс добавления, и лишь после этого приходит ответ.
-=== Выполнение кода === <!--T:301-->
+== Сирена (create-siren) == <!--T:263-->
-<!--T:302-->
+Запрос:
-Request URL: [site]/api/wizard/execute-code
-<!--T:303-->
+<!--T:264-->
-Params:
+Request URL: [site]/api/wizard/create-siren
-<!--T:304-->
+<!--T:265-->
-controller_id (required): int
+Параметры запроса:
-<!--T:305-->
+<!--T:266-->
-token (required): string, 64
+#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
-<!--T:306-->
+<!--T:272-->
-code (required): int // Берется из сгенерированных
+Ответ:
-<!--T:307-->
+Пример ответа:
-Response:
 <pre>
 {
-	error: null,
 	data: {
-		"response":"OK"
+		'response': 'OK'
-		}
+		},
+	error: null
 }
 </pre>
-=== Добавление крана === <!--T:308-->
+Перед отправкой параметров необходимо перевести сирену в режим обучения.
-<!--T:309-->
-Request URL: [site]/api/wizard/create-crane-by-codes
-<!--T:310-->
+== Метеостанция: получение списка обнаруженных метеостанций за последние 10 минут (get-meteos) == <!--T:273-->
-Params:
-<!--T:311-->
+Запрос:
-controller_id (required): int
-<!--T:312-->
+Request URL: [site]/api/wizard/get-meteos
-token (required): string, 64
-<!--T:313-->
+<!--T:274-->
-code_1 (required): int
+Параметры запроса:
-<!--T:314-->
+<!--T:275-->
-code_2 (required): int
+#controller_id (required): int
+#token (required): string, 64
-<!--T:315-->
+<!--T:277-->
-device_name (optional): string, 256
+Ответ:
-<!--T:316-->
+Пример ответа:
-code_open (optional): string, 64 //Название кода открытия
-<!--T:317-->
-code_close (optional): string, 64 //Название кода закрытия
-<!--T:318-->
-RESPONSE:
 <pre>
 {
-	data:{'response': 'OK'},
+	"error":null,
-	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>
-== Добавление розетки == <!--T:319-->
+== Метеостанция: добавление (create-meteo) == <!--T:278-->
-<!--T:320-->
+Запрос:
-порядок добаления розетки следующий:
-<!--T:321-->
+<!--T:279-->
-) Сгенерировать коды
+Request URL: [site][site]/api/wizard/create-meteo
-<!--T:322-->
+<!--T:280-->
-) Зажать на розетке кнопку, пока она не начнет мигать
+Параметры запроса:
-<!--T:323-->
+<!--T:281-->
-) Отправить один код
+#controller_id (required): int
+#token (required): string, 64
+#meteo_num (required): int //Получается в списке выше
+#device_name (optional): string, 256
-<!--T:324-->
+<!--T:285-->
-) Зажать на розетке кнопку, пока она не начнет мигать
+Ответ:
-<!--T:325-->
+Пример ответа:
-) Отправить второй код из сгенерированых
+<pre>
+{
+	"error":null,
+	"data":{
+		"response":"OK"
+		}
+}
+</pre>
-<!--T:326-->
+== Водопроводный кран == <!--T:286-->
-) Отправить запрос на создание розетки
+<!--T:287-->
+Порядок добавления крана:
-=== Генерация кодов (create-codes) === <!--T:327-->
+) Сгенерировать коды
-<!--T:328-->
+<!--T:288-->
-Request URL: [site]/api/wizard/create-codes
+) Зажать на кране кнопку, пока кран не мигнёт трижды
-<!--T:329-->
+<!--T:289-->
-Params:
+) Отправить один код
-<!--T:330-->
+<!--T:290-->
-controller_id (required): int
+) Нажать на кране кнопку однократно
-<!--T:331-->
+<!--T:291-->
-token (required): string, 64
+) Зажать на кране кнопку, пока не мигнёт 4 раза
-<!--T:332-->
+<!--T:292-->
-socket (required): любое значение.
+) Отправить второй код из сгенерированных
-<!--T:333-->
+<!--T:293-->
-Response:
+) Нажать на кране кнопку однократно
-<pre>
-{
-	"error":null,
-	"data":{
-		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
-		}
-}
-</pre>
+<!--T:294-->
+) Отправить запрос на создание крана.
-=== Выполнение кода  (execute-code) === <!--T:334-->
-<!--T:335-->
+=== Генерация кодов === <!--T:295-->
-Request URL: [site]/api/wizard/execute-code
-<!--T:336-->
+Запрос:
-Params:
-<!--T:337-->
+<!--T:296-->
-controller_id (required): int
+Request URL: [site]/api/wizard/create-codes
+<!--T:297-->
+Параметры запроса:
+<!--T:298-->
+#controller_id (required): int
+#token (required): string, 64
-<!--T:338-->
+<!--T:300-->
-token (required): string, 64
+Ответ:
-<!--T:339-->
+Пример ответа:
-code (required): int // Берется из сгенерированных
-<!--T:340-->
-Response
 <pre>
 {
-	error: null,
+	"error":null,
-	data: {'response' => 'OK'}
+	"data":
+		{
+			"response":{
+					"id":30,
+					"masks":"[6,4,0,1]",
+					"code_1":"9920950",
+					"code_2":"9920948",
+					"code_3":"9920944",
+					"code_4":"9920945"
+				}
+		}
 }
 </pre>
-=== Добавление розетки (create-socket) === <!--T:341-->
+=== Выполнение кода === <!--T:301-->
-<!--T:342-->
+Запрос:
-Request URL: [site]/api/wizard/create-socket
-<!--T:343-->
+<!--T:302-->
-Params:
+Request URL: [site]/api/wizard/execute-code
-<!--T:344-->
+<!--T:303-->
-controller_id (required): int
+Параметры запроса:
-<!--T:345-->
+<!--T:304-->
-token (required): string, 64
+#controller_id (required): int
+#token (required): string, 64
+#code (required): int // Берется из сгенерированных
-<!--T:346-->
+<!--T:307-->
-code_1 (required): int
+Ответ:
-<!--T:347-->
+Пример ответа:
-code_2 (required): int
-<!--T:348-->
+<pre>
-device_name (optional): string, 256
-<!--T:349-->
-code_off (optional): string, 64 //Название кода открытия
-<!--T:350-->
-code_on (optional): string, 64 //Название кода закрытия
-<!--T:351-->
-RESPONSE:
-<pre>
 {
-	data: {'response':'OK'},
+	error: null,
-	error: null
+	data: {
+		"response":"OK"
+		}
 }
 </pre>
-= Сценарии = <!--T:352-->
+=== Добавление крана === <!--T:308-->
+Запрос:
+<!--T:309-->
+Request URL: [site]/api/wizard/create-crane-by-codes
+<!--T:310-->
+Параметры запроса:
-== Список сценариев (list) == <!--T:353-->
+<!--T:311-->
+#controller_id (required): int
+#token (required): string, 64
+#code_1 (required): int
+#code_2 (required): int
+#device_name (optional): string, 256
+#code_open (optional): string, 64 //Название кода открытия
+#code_close (optional): string, 64 //Название кода закрытия
-<!--T:354-->
+<!--T:318-->
-request:
+Ответ:
-Request URL: [site]/api/scheduler/list/
-<!--T:355-->
+Пример ответа:
-параметры запроса: (string) token
-<!--T:356-->
-Пример запроса:
 <pre>
 {
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	data:{'response': 'OK'},
+	error: null
 }
 </pre>
-<!--T:357-->
+== Добавление розетки == <!--T:319-->
-response:
-<!--T:358-->
+<!--T:320-->
-параметры ответа:
+Порядок добавления розетки следующий:
-<!--T:359-->
+<!--T:321-->
-Пример ответа:
+) Сгенерировать коды
-<pre>
-{
-"0":{
-	"id":9,
-	"external_id":42,
-	"name":"test_form_web",
-	"operation":"local",
-	"armed":0,
-	"type":"meteo",
-	"action_id":1,
-	"a_controller_id":6,
-	"a_device_id":112,
-	"a_code_id":0,
-	"a_device_external_id":38,
-	"a_armed":0,
-	"a_conf1":0,
-	"a_conf2":0,
-	"a_conf3":0,
-	"a_conf4":0,
-	"a_conf5":0,
-	"a_conf6":0,
-	"a_conf7":0,
-	"a_conf8":0,
-	"target_id":1,
-	"t_controller_id":6,
-	"t_device_id":119,
-	"t_code_id":203,
-	"t_device_external_id":7,
-	"t_armed":0,
-	"t_conf1":0,
-	"t_conf2":0,
-	"t_conf3":0,
-	"t_conf4":0,
-	"t_conf5":0,
-	"t_conf6":0,
-	"t_conf7":0,
-	"t_conf8":0,
-	"date":null,
-	"repetition":"0",
-	"sensor_type":"1",
-	"logic_operation":"=",
-	"value":"3",
-	"active":1
-	},
-"1":{
-	"id":10,
-	"external_id":45
-	...
-	}
-}
-<!--T:360-->
+<!--T:322-->
-</pre>
+) Зажать на розетке кнопку, пока она не начнет мигать
+<!--T:323-->
+) Отправить один код
-== Обновление сценариев (update) == <!--T:361-->
+<!--T:324-->
+) Зажать на розетке кнопку, пока она не начнет мигать
-<!--T:362-->
+<!--T:325-->
-Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера");
+) Отправить второй код из сгенерированых
-на втором этапе обновляется информация о каждом действии.
-<!--T:363-->
+<!--T:326-->
-request:
+) Отправить запрос на создание розетки
-Request URL: [site]/api/scheduler/update/
+=== Генерация кодов (create-codes) === <!--T:327-->
+Запрос:
+<!--T:328-->
+Request URL: [site]/api/wizard/create-codes
+<!--T:329-->
+Параметры запроса:
-<!--T:364-->
+<!--T:330-->
-параметры запроса:
+#controller_id (required): int
+#token (required): string, 64
+#socket (required): любое значение.
-<!--T:365-->
+<!--T:333-->
-(int) controller_id,
+Ответ:
-<!--T:366-->
+Пример ответа:
-(string) token
-<!--T:367-->
-Пример запроса:
 <pre>
 {
-	"controller_id": 6 ,
+	"error":null,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"data":{
+		"response":{"id":30,"masks":"[257, 258]","code_1":"8737025","code_2":"8737026"}
+		}
 }
 </pre>
-<!--T:368-->
+=== Выполнение кода  (execute-code) === <!--T:334-->
-response:
-<!--T:369-->
+Запрос:
-параметры ответа:
-<!--T:370-->
+<!--T:335-->
-Пример ответа:
+Request URL: [site]/api/wizard/execute-code
+<!--T:336-->
+Параметры запроса:
+<!--T:337-->
+#controller_id (required): int
+#token (required): string, 64
+#code (required): int // Берется из сгенерированных
+<!--T:340-->
+Ответ:
+Пример ответа:
 <pre>
 {
-	"result": "Ok" // ответ что запрос ушел
+	error: null,
+	data: {'response' => 'OK'}
 }
 </pre>
-Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)
-== Информация о сценарии (info) == <!--T:371-->
+=== Добавление розетки (create-socket) === <!--T:341-->
-<!--T:372-->
+Запрос:
-request:
-Request URL: [site]/api/scheduler/info/
-<!--T:373-->
+<!--T:342-->
-параметры запроса:
+Request URL: [site]/api/wizard/create-socket
-<!--T:374-->
+<!--T:343-->
-(int) scheduler_id,
+Параметры запроса:
-<!--T:375-->
+<!--T:344-->
-(string) token
+#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 //Название кода закрытия
-<!--T:376-->
+<!--T:351-->
-Пример ответа:
+Ответ:
+Пример ответа:
 <pre>
 {
-	"scheduler_id": 122,
+	data: {'response':'OK'},
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	error: null
 }
 </pre>
-response:
-<!--T:377-->
+= Сценарии = <!--T:352-->
-параметры ответа:
+== Получение списка сценариев (list) == <!--T:353-->
+<!--T:354-->
+Запрос:
+Request URL: [site]/api/scheduler/list/
+<!--T:355-->
+Параметры запроса: (string) token
-<!--T:378-->
+<!--T:356-->
-Пример ответа:
+Пример запроса:
 <pre>
 {
-	"id":9,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-	"external_id":42,
-	"name":"test_form_web",
-	"operation":"local",
-	"armed":0,
-	"type":"meteo",
-	"action_id":1,
-	"a_controller_id":6,
-	"a_device_id":112,
-	"a_code_id":0,
-	"a_device_external_id":38,
-	"a_armed":0,
-	"a_conf1":0,
-	"a_conf2":0,
-	"a_conf3":0,
-	"a_conf4":0,
-	"a_conf5":0,
-	"a_conf6":0,
-	"a_conf7":0,
-	"a_conf8":0,
-	"target_id":1,
-	"t_controller_id":6,
-	"t_device_id":119,
-	"t_code_id":203,
-	"t_device_external_id":7,
-	"t_armed":0,
-	"t_conf1":0,
-	"t_conf2":0,
-	"t_conf3":0,
-	"t_conf4":0,
-	"t_conf5":0,
-	"t_conf6":0,
-	"t_conf7":0,
-	"t_conf8":0,
-	"date":null,
-	"repetition":"0",
-	"sensor_type":"1",
-	"logic_operation":"=",
-	"value":"3",
-	"active":1
 }
 </pre>
+<!--T:357-->
+Ответ:
+<!--T:359-->
-= Логи пользователя (logs) = <!--T:379-->
+Пример ответа:
-request:
-<!--T:380-->
-Request URL: [site]/api/profile/logs/
-<!--T:381-->
-параметры запроса: (string) token
-<!--T:382-->
-Пример запроса:
 <pre>
 {
-	"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,
+		...
+		}]
+	}
 }
+<!--T:360-->
 </pre>
-response:
-параметры ответа: (object)
-пример:
-{
-}
+== Обновление/добавление сценариев (update) == <!--T:361-->
+<!--T:362-->
+Запрос осуществляется в 2 этапа: на первом этапе происходит при запросе на обновление Контроллера (см. "Обновление Контроллера");
+на втором этапе обновляется информация о каждом действии.
+<!--T:363-->
+Запрос:
+Request URL: [site]/api/scheduler/update/
+<!--T:364-->
+Параметры запроса:
-= Коды = <!--T:383-->
+<!--T:365-->
+#(int) controller_id,
+#(string) token
-== Получение информации о коде (info) == <!--T:384-->
+Пример запроса:
+<pre>
+{
+	"controller_id": 6 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+}
+</pre>
-<!--T:385-->
+<!--T:368-->
-request:
+Ответ:
-<!--T:386-->
+<!--T:370-->
-Request URL: [site]/api/property/info/
+Пример ответа:
+<pre>
+{
+	"result": "Ok" // ответ что запрос ушел
+}
+</pre>
-<!--T:387-->
+Процесс обновления происходит автоматически. Для получения результата требуется таймаут, после чего делается стандартный запрос на получение данных (Контроллер, действия)
-параметры запроса:
-(int) controller_id,
-<!--T:388-->
+== Информация о сценарии (info) == <!--T:371-->
-(int) device_id,
-<!--T:389-->
+<!--T:372-->
-(int) code_id,
+Запрос:
-<!--T:390-->
+Request URL: [site]/api/scheduler/info/
-(string) token
-<!--T:391-->
+<!--T:373-->
-Пример запроса:
+Параметры запроса:
+<!--T:374-->
+#(int) scheduler_id,
+#(string) token
+<!--T:376-->
+Пример запроса:
 <pre>
 {
-	"controller_id": 6,
+	"scheduler_id": 122,
-	"device_id": 109,
-	"code_id": 192,
 	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-<!--T:392-->
 }
 </pre>
-<!--T:393-->
+Ответ:
-response:
-параметры ответа:
-<!--T:394-->
+<!--T:378-->
-Пример ответа:
+Пример ответа (data):
 <pre>
 {
-	"id":"192",
+"id":107,
-	"external_cod_id":"67",
+"external_id":6,
-	"device_id":"109",
+"name":"Test 1.1.1",
-	"name":"4 OFF",
+"operation":"local",
-	"code":"12209156",
+"armed":1,
-	"protocol":"1",
+"type":"device",
-	"pulse_len":null,
+"active":1,
-	"group_1":"1",
+"action":{
-	"group_2":"0",
+	"action_id":1,
-	"group_3":"0",
+	"controller_id":111,
-	"group_4":"0",
+	"device_id":1824,
-	"group_5":"0",
+	"code_id":1399,
-	"group_6":"0",
+	"device_external_id":18,
-	"group_7":"0",
+	"armed":0,
-	"group_8":"0",
+	"groups":0,
-	"active":"1"
+	"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) == <!--T:395-->
-<!--T:396-->
+== Обновление сценариев (update) == <!--T:371-->
-Request URL: [site]/api/device/update-code-name
+Обновление состоит из двух запросов: 1) обновление действия, вызывающего событие; 2) обновления целей сработки.
+При этом запросы можно делать независимо друг от друга.
-<!--T:397-->
+=== Обновление/добавление действий и событий сценария (Update-action) ===
-Request Params:
-<!--T:398-->
+Request URL: [site]/api/scheduler/update-action/
-token (required): string(64)
-<!--T:399-->
+Параметры запроса:
-code_id (required): int
-<!--T:400-->
+#(int) scheduler_id,
-name (optional): string(255)
+#(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"
-<!--T:401-->
+Пример запроса:
-SUCCESS RESPONSE:
 <pre>
 {
-	data: {
+	"scheduler_id": 6 ,
-		'message': "OK"
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		},
+	"name": "New name",
-	error: null
+	"active": 1,
+	"send_sms": 0,
+	"make_call": 1,
+	"armed": 2,
+	"action_id" : 2,
+	"action_device_id" : 2,
+	"action_code_id" : 4,
+	"action_armed" : 0,
+	"action_groups" : 7,
+	"action_repetition" : "1,3",
+	"action_event_time" : "10:00",
+	"action_sensor_type" : 2,
+	"action_logic_operation" : "=",
+	"action_value" : 35,
 }
 </pre>
+Ответ:
-==  Получение кодов по типу сигнала (get-codes-by-subtype) == <!--T:402-->
+Пример ответа:
+<pre>
+{
+	"result": "Ok" // ответ о том, что запрос отправлен.
+}
+</pre>
-<!--T:403-->
+=== Обновление цели события (Update-target) ===
-Request URL: [site]/api/device/get-codes-by-subtype
-<!--T:404-->
-Request Params:
-<!--T:405-->
+Request URL: [site]/api/scheduler/update-target/
-token (required): string(64)
-<!--T:406-->
+Параметры запроса:
-device_subtype_id (optional): int, default 0.
-==  Получение списка кодов (get-codes) == <!--T:407-->
+#(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
-<!--T:408-->
+Пример запроса:
-Request URL: [site]/api/device/get-codes
+<pre>
+{
+	"target_id": 6 ,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
+	"target_type_id" : 2,
+	"target_device_id" : 2,
+	"target_code_id" : 4,
+	"target_armed" : 0,
+	"target_groups" : 7
+}
+</pre>
-<!--T:409-->
+Ответ:
-PARAMS:
-token (required): string 64
-<!--T:410-->
+Пример ответа:
-controller_id (required): int
-<!--T:411-->
-SUCCESS RESPONSE:
 <pre>
 {
-	data: [
+	"result": "Ok" // ответ о том, что запрос отправлен.
-		{
+}
-			devices:	[
+</pre>
-			{
-				id:	13
-				external_id:	7,
+= Логи пользователя (logs) = <!--T:379-->
-				controller_id:	5,
-				name:	"Simple device",
+Запрос:
-				type_id:	2,
-				password:	null,
+<!--T:380-->
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+Request URL: [site]/api/profile/logs/
-				state:	1,
-				on_dashboard:	0,
+<!--T:381-->
-				active:	1,
+Параметры запроса: (string) token, (int) page, (int) limit
-				new:	1,
-				family:	DEVICE_FAMILY_RADIO,
+<!--T:382-->
-				camera_id:	null,
+Пример запроса:
-				camera_host:	null
-			},
+<pre>
-			{
+{
-				id:	14
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-				external_id:	8,
+	"page": 1 // номер страницы лога
-				controller_id:	5,
+	"limit": 20 // количество логов на странице , по умолчанию 20, максимум 100
-				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;}",
+Ответ:
-				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:412-->
+<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/
+<!--T:387-->
+Параметры запроса:
+#(int) controller_id,
+#(int) device_id,
+#(int) code_id,
+#(string) token
+<!--T:391-->
+Пример запроса:
-		<!--T:413-->
+<pre>
 {
-			devices:	[
+	"controller_id": 6,
-			{
+	"device_id": 109,
-				id:	13
+	"code_id": 192,
-				external_id:	7,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
-				controller_id:	5,
+}
-				name:	"Simple device",
+</pre>
-				type_id:	2,
-				password:	null,
+<!--T:393-->
-				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:394-->
-				active:	1,
+Пример ответа (data):
-				new:	1,
-				family:	DEVICE_FAMILY_RADIO,
+<pre>
-				camera_id:	null,
+{
-				camera_host:	null
+	"id":"1465",
-			},
+	"external_cod_id":"59",
-			{
+	"device_id":"1866",
-				id:	14
+	"name":"alarm",
-				external_id:	8,
+	"alias":"xxx",
-				controller_id:	5,
+	"code":"15779537",
-				name:	"Simple device",
+	"msg_cod":"003001",
-				type_id:	2,
+	"send_armed":"INFO",
-				password:	null,
+	"send_disarmed":"INFO",
-				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+	"protocol":"1",
-				state:	1,
+	"pulse_len":null,
-				on_dashboard:	0,
+	"group_1":"0",
-				active:	1,
+	"group_2":"0",
-				new:	1,
+	"group_3":"0",
-				family:	DEVICE_FAMILY_RADIO,
+	"group_4":"0",
-				camera_id:	null,
+	"group_5":"0",
-				camera_host:	null
+	"group_6":"0",
-			},
+	"group_7":"0",
-		],
+	"group_8":"0",
-		code: {
+	"active":"1",
-			id:	12,
+	"send_sms":"0",
-			controller_id: 5,
+	"voice_call":"0"
-			device_type_id:	2,
+}
-			code: 498654,
+</pre>
-			protocol: 1,
-			bit_len: 32,
-			pulse_len:	86,
-			freq:	77,
-			address:	94,
-			num:	1,
-			date_create: '2018-04-13 18:29:11"
-		<!--T:414-->
+== Изменение имени кода (update-code-name) == <!--T:395-->
-}
-		},
-	},
-	error: null,
-}
-</pre>
-== Добавление кода к устройству (set-code-to-device) == <!--T:415-->
+Запрос:
+<!--T:396-->
+Request URL: [site]/api/device/update-code-name
-<!--T:416-->
+<!--T:397-->
-Request URL: [site]/api/device/set-code-to-device
+Параметры запроса:
-<!--T:417-->
+<!--T:398-->
-PARAMS:
+#token (required): string(64)
+#code_id (required): int
+#name (optional): string(255)
-<!--T:418-->
+<!--T:401-->
-token (required): string 64
+Ответ:
-<!--T:419-->
+Пример ответа:
-code_id (required): int
-<!--T:420-->
+<pre>
-device_id (required): int
+{
+	data: {
+		'message': "OK"
+		},
+	error: null
+}
+</pre>
-<!--T:421-->
+== Редактирование параметров кода (update) ==
-name (optional): string 256
-<!--T:422-->
+<!--T:401-->
-SUCCESS RESPONSE:
+Запрос:
-<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:401-->
+Request URL: [site]/api/property/update/
-<!--T:424-->
+<!--T:401-->
-Request URL: [site]/api/device/remove-code
+Параметры запроса:
-PARAMS:
-<!--T:425-->
+#(string) token
-token (required): string 64
+#(int) device_id
+#(int) code_id
+#(string) name		// опционально
+#(int) active		// опционально
+#(int) send_sms		// опционально
+#(int) voice_call	// опционально
-<!--T:426-->
+<!--T:401-->
-code_id (required): int
+Пример запроса:
-<!--T:427-->
-SUCCESS RESPONSE:
 <pre>
 {
-	data:	{
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae",
-		message: "OK"
+	"device_id" : 111,
-	},
+	"code_id" : 111,
-	error: null
+	"send_sms": 1
 }
 </pre>
-= События = <!--T:428-->
+<!--T:402-->
+Ответ:
-== Нажатие кнопки на устройстве (event) == <!--T:429-->
+<!--T:402-->
+Пример ответа (data):
-<!--T:430-->
+<pre>
-request:
+{
+	"result": "Ok"
+}
+</pre>
-<!--T:431-->
+==  Получение кодов по типу сигнала (get-codes-by-subtype) == <!--T:402-->
-Request URL: [site]/api/device/event/
-параметры запроса:
-<!--T:432-->
+Запрос:
-(string) controller_name,
-<!--T:433-->
+<!--T:403-->
-(int) device_external_id,
+Request URL: [site]/api/device/get-codes-by-subtype
-<!--T:434-->
+<!--T:404-->
-(int) cod_external_id,
+Параметры запроса:
-<!--T:435-->
+<!--T:405-->
-(string) token,
+#token (required): string(64)
+#device_subtype_id (optional): int, default 0.
-<!--T:436-->
+Ответ:
-(int) device_type
-<!--T:437-->
+Пример ответа:
-Пример запроса:
-<!--T:438-->
 <pre>
 {
-	"controller_name": " AS_7F26335CCF4B" ,
+	"code"
-	"device_external_id": 19,
+	"id":131,
-	"cod_external_id": 1,
+	"controller_id":109,
-	"device_type": 1,
+	"device_type_id":0,
-	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
+	"device_subtype_id":1,
+	"code":"655370",
+	"protocol":1,
+	"bit_len":24,
+	"pulse_len":283,
+	"freq":2,"address":null,
+	"num":null,
+	"date_create":"2019-03-13 17:35:05",
+	"device_id":null
+	},
+	"devices":[
+	{
+		"id":"1684",
+		"external_id":"64",
+		"controller_id":"109",
+		"name":"WS 1",
+		"alias":null,
+		"type_id":"12",
+		"password":null,
+		"codes":[178,179,180],
+		"state":"1",
+		"on_dashboard":"0",
+		"active":"1",
+		"new":"1",
+		"family":"DEVICE_FAMILY_RADIO",
+		"camera_id":null,
+		"camera_host":null,
+		"send_sms":"0",
+		"voice_call":"0"
+	},
+	{
+		"id":"1738",
+		"external_id":"115",
+		"controller_id":"109",
+		"name":"Pult 123",
+		"alias":null,
+		"type_id":"3",
+		"password":null,
+		"codes":[280,281,282,283],
+		"state":"1",
+		"on_dashboard":"0",
+		"active":"1",
+		"new":"1",
+		"family":"DEVICE_FAMILY_RADIO",
+		"camera_id":null,
+		"camera_host":null,
+		"send_sms":"0",
+		"voice_call":"0"
+	}
+	]
 }
 </pre>
-<!--T:439-->
+==  Получение списка кодов (get-codes) == <!--T:407-->
-так как MQTT  односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен:
-response:
-<!--T:440-->
+Запрос:
-параметры ответа:
-<!--T:441-->
+<!--T:408-->
-Пример ответа:
+Request URL: [site]/api/device/get-codes
-<!--T:442-->
+<!--T:409-->
-<pre>
+Параметры:
-{
-	"result": "Ok"
-}
-</pre>
-= Места = <!--T:443-->
+#token (required): string 64
+#controller_id (required): int
-== Получение списка мест (places-list) == <!--T:444-->
+Ответ:
-<!--T:445-->
+<!--T:411-->
-Request URL: [site]/api/places/places-list
+Пример ответа:
-<!--T:446-->
-Request params:
-<!--T:447-->
-token (required): string, 64
-<!--T:448-->
-Response:
 <pre>
 {
-	"error":null,
+	data: [
-	"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}]
+			devices:	[
-		}
+			{
-}
+				id:	13
-</pre>
+				external_id:	7,
+				controller_id:	5,
+				name:	"Simple device",
-== Создание места (create) == <!--T:449-->
+				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:450-->
+				state:	1,
-Request URL: [site]/api/places/create
+				on_dashboard:	0,
+				active:	1,
-<!--T:451-->
+				new:	1,
-Request params:
+				family:	DEVICE_FAMILY_RADIO,
+				camera_id:	null,
-<!--T:452-->
+				camera_host:	null
-token (required): string, 64
+			},
+			{
-<!--T:453-->
+				id:	14
-root (optional): int, default 1
+				external_id:	8,
+				controller_id:	5,
-<!--T:454-->
+				name:	"Simple device",
-lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+				type_id:	2,
+				password:	null,
-<!--T:455-->
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
-rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+				state:	1,
+				on_dashboard:	0,
-<!--T:456-->
+				active:	1,
-lvl (optional): int, default 0
+				new:	1,
+				family:	DEVICE_FAMILY_RADIO,
-<!--T:457-->
+				camera_id:	null,
-name (optional): string, 64, default 'Simple name'
+				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:458-->
+		<!--T:412-->
-icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+}
+		},
-<!--T:459-->
+		<!--T:413-->
-color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
-<!--T:460-->
-active (optional): int, default 1
-<!--T:461-->
-selected (optional): int, default 0
-<!--T:462-->
-disabled (optional): int, default 0
-<!--T:463-->
-readonly (optional): int, default 0
-<!--T:464-->
-visible (optional): int, default 1
-<!--T:465-->
-collapsed (optional): int, default 0
-<!--T:466-->
-movable_u (optional): int, default 1
-<!--T:467-->
-movable_d (optional): int, default 1
-<!--T:468-->
-movable_l (optional): int, default 1
-<!--T:469-->
-movable_r (optional): int, default 1
-<!--T:470-->
-removable (optional): int, default 1
-<!--T:471-->
-removable_all (optional): int, default 0
-<!--T:472-->
-inverse_text (optional): string, default 'black'
-<!--T:473-->
-Response:
-<pre>
 {
-	error:null,
+			devices:	[
-	data: {'message': 'OK'}
+			{
-}
+				id:	13
-</pre>
+				external_id:	7,
+				controller_id:	5,
+				name:	"Simple device",
-==  Редактирование места (edit) == <!--T:474-->
+				type_id:	2,
+				password:	null,
-<!--T:475-->
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
-Request URL: [site]/api/places/edit
+				state:	1,
+				on_dashboard:	0,
-<!--T:476-->
+				active:	1,
-Request params:
+				new:	1,
+				family:	DEVICE_FAMILY_RADIO,
-<!--T:477-->
+				camera_id:	null,
-token (required): string, 64
+				camera_host:	null
+			},
-<!--T:478-->
+			{
-place_id (required): int
+				id:	14
+				external_id:	8,
-<!--T:479-->
+				controller_id:	5,
-root (optional): int, default 1
+				name:	"Simple device",
+				type_id:	2,
-<!--T:480-->
+				password:	null,
-lft (optional): int, from 1 to 5 //В сумме с rgt должно быть 5
+				codes:	"a:4:{i:0;i:46;i:1;i:47;i:2;i:48;i:3;i:45;}",
+				state:	1,
-<!--T:481-->
+				on_dashboard:	0,
-rgt (optional): int, from 1 to 5 //В сумме с lft должно быть 5
+				active:	1,
+				new:	1,
-<!--T:482-->
+				family:	DEVICE_FAMILY_RADIO,
-lvl (optional): int, default 0
+				camera_id:	null,
+				camera_host:	null
-<!--T:483-->
+			},
-name (optional): string, 64, default 'Simple name'
+		],
+		code: {
-<!--T:484-->
+			id:	12,
-icon (optional): string, default '' //Допускаемые параметры -- ключи объекта выше
+			controller_id: 5,
+			device_type_id:	2,
-<!--T:485-->
+			code: 498654,
-color (optional): string, default: '#ccc' //Любой цвет в формате HEX, решетка в начале обязательна
+			protocol: 1,
+			bit_len: 32,
-<!--T:486-->
+			pulse_len:	86,
-active (optional): int, default 1
+			freq:	77,
+			address:	94,
-<!--T:487-->
+			num:	1,
-selected (optional): int, default 0
+			date_create: '2018-04-13 18:29:11"
-<!--T:488-->
+		<!--T:414-->
-disabled (optional): int, default 0
+}
+		},
+	},
+	error: null,
+}
+</pre>
-<!--T:489-->
+== Добавление кода к устройству (set-code-to-device) == <!--T:415-->
-readonly (optional): int, default 0
-<!--T:490-->
+Запрос:
-visible (optional): int, default 1
-<!--T:491-->
+<!--T:416-->
-collapsed (optional): int, default 0
+Request URL: [site]/api/device/set-code-to-device
-<!--T:492-->
+<!--T:417-->
-movable_u (optional): int, default 1
+Параметры запроса:
-<!--T:493-->
+<!--T:418-->
-movable_d (optional): int, default 1
+#token (required): string 64
+#code_id (required): int
+#device_id (required): int
+#name (optional): string 256
-<!--T:494-->
+<!--T:422-->
-movable_l (optional): int, default 1
+Ответ:
-<!--T:495-->
-movable_r (optional): int, default 1
-<!--T:496-->
-removable (optional): int, default 1
-<!--T:497-->
-removable_all (optional): int, default 0
-<!--T:498-->
-inverse_text (optional): string, default 'black'
+Пример ответа:
-<!--T:499-->
-Response:
 <pre>
 {
-	error:null,
+	data:	{
-	data: {'message': 'OK'}
+		id: 5,
+		external_cod_id: 15,
+		device_id: 14,
+		name: "Name"
+		code: 8463517,
+		protocol: 0,
+		pulse_len:	86,
+		active: 1,
+	},
+	error: null
 }
-<!--T:500-->
 </pre>
-== Удаление места (delete) == <!--T:501-->
+== Удаление кода (remove-code) == <!--T:423-->
-<!--T:502-->
+Запрос:
-Request URL: [site]/api/places/delete
-<!--T:503-->
+<!--T:424-->
-Request params:
+Request URL: [site]/api/device/remove-code
-<!--T:504-->
+Параметры запроса:
-token (required): string, 64
+<!--T:425-->
+#token (required): string 64
+#code_id (required): int
+<!--T:427-->
+Ответ:
-<!--T:505-->
+Пример ответа:
-place_id (required): int
-<!--T:506-->
-Response:
 <pre>
 {
-	error:null,
+	data:	{
-	data: {'message': 'OK'}
+		message: "OK"
+	},
+	error: null
 }
 </pre>
+= События = <!--T:428-->
+== Нажатие кнопки на устройстве (event) == <!--T:429-->
+<!--T:430-->
+Запрос:
+<!--T:431-->
+Request URL: [site]/api/device/event/
-==  Активация подписки Ebus  == <!--T:507-->
+Параметры запроса:
+<!--T:432-->
+#(string) controller_name,
+#(int) device_external_id,
+#(int) cod_external_id,
+#(string) token,
+#(int) device_type
-<!--T:508-->
+<!--T:437-->
-Получение состояния подписки на Контроллере - “in/subscription/get”:
+Пример запроса:
-<!--T:509-->
+<!--T:438-->
 <pre>
 {
-	"id": 1, // ID подписки (см. ниже)
+	"controller_name": " AS_7F26335CCF4B" ,
-	"seq_id": 0
+	"device_external_id": 19,
+	"cod_external_id": 1,
+	"device_type": 1,
+	"token":"_zcX0_QceAqgP_seIvjG32EC3HMO34ae"
 }
 </pre>
-<!--T:510-->
+<!--T:439-->
-Ответ:
+так как MQTT  односторонний - ответа быть не может. Может быть возвращён ответ, что запрос отправлен:
+response:
-<!--T:511-->
+Ответ:
-<pre>
-{
-	"seq_id": 0,
-	"remain_time": 100, // оставшееся время в секундах, 4294967295 – неограниченно
-	"success": 0/1
-}
-</pre>
-<!--T:512-->
+<!--T:441-->
-Установка подписки на Контроллере - “in/subscription/set”:
+Пример ответа (data):
-<!--T:513-->
+<!--T:442-->
 <pre>
 {
-	"seq_id": 0,
+	"result": "Ok"
-	"id": 1, // ID подписки (см. ниже)
-	"remain_time": 100 // оставшееся время в секундах, 4294967295 - неограниченно
 }
 </pre>
-<!--T:514-->
+= Места = <!--T:443-->
-Ответ:
-<pre>
+== Получение списка мест (places-list) == <!--T:444-->
+Запрос:
+<!--T:445-->
+Request URL: [site]/api/places/places-list
+<!--T:446-->
+Параметры запроса: token (required): string, 64
+<!--T:448-->
+Ответ:
+Пример ответа:
+<pre>
 {
-	"seq_id": 0,
+	"error":null,
-	"success": 0/1
+	"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>
-<!--T:515-->
-Идентификаторы подписок:
-SUBSCRIPTION_EBUS = 1
-<!--T:516-->
+== Создание места (create) == <!--T:449-->
-Статус Контроллера
+Запрос:
-<!--T:517-->
+<!--T:450-->
-Контроллер отправляет информацию о своем онлайн/оффлайн статусе в топик “out/status”.
+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-->
+Ответ:
+Пример ответа:
-<!--T:518-->
+<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>
 {
@@ Строка 2614: / Строка 3079: @@
 </pre>
 <!--T:519-->
 Поле “status” может принимать следующие значения:
 <!--T:520-->
 • "0" – оффлайн
 <!--T:521-->
 • "1" – онлайн
 <!--T:522-->
 • "2" – онлайн, после включения питания
 <!--T:523-->
 При получении сообщения со статусом "2", портал должен отправить Контроллеру информацию о пользовательских подписках, как это описано в разделе «Подписки».
-= Ошибки = <!--T:524-->
+= Виджеты = <!--T:524-->
-<!--T:525-->
+== Список виджетов пользователя (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."
+		]
+	}
+}
+</pre>
-<!--T:526-->
-<pre>
-{
-	"errors":{
-		"password": [
-			"Incorrect username."
-		]
-	}
-}
-</pre>
 </translate>

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

Текущая версия на 16: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)