网关模块

获取网关配置

请求链接: /gateway/getGatewayConfig
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
无

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

json

{
  "starcloudRpcPeerId": "",
  "starcloudReportPeerId": "",
  "starcloudUrl": "https://cloud.local.star-lock.cn",
  "userPeerId": "1",
  "scdUrl": "http://sls1-scd.star-lock.cn:8710",
  "starlockPeerId": "0b3bd6327daafe2da24fdd0cae76c71477f32e3ef8ab",
  "clientId": "TMwurHIlxuRdS7lkiHPdOJlBgWutBoW1",
  "secretKey": "1cJ3lrB3sRPqOaxXYc"
}

网关-添加

请求链接: /gateway/add
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayName	String	Y	"G2（WI-FI）网关"	网关名称
gatewayMac	String	Y	"00:00:00:00:00:00"	网关MAC地址
serialNumber	String	Y	"1"	网关序列号
gatewayType	int	Y	1	网关类型，参考常量列表 0.4.19. 网关类型列表
networkName	String	Y	""	WiFi名称
networkMac	String	Y	"00:00:00:00:00:00"	WiFi-MAC地址
version	String	Y	"1.0.0"	网关当前版本
gatewayJson	String	Y	"{"peerId": "AYzRsyaj9h4wbibCzJZE7Gki3pedTqz27QgFBfGPsYCp","secretKey": "090icLDU9WzAZJkeEb"}"	网关添加完成时候的JSON透传

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

json

{
  "gatewayId": 13
}

网关-列表

请求链接: /gateway/list
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
pageNo	int	Y	1	页码
pageSize	int	Y	20	每页显示数

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

json

{
  "list": [
    {
      "serialNumber": "0000000000000000",
      "gatewayMac": "00:00:00:00:00:02",
      "gatewayName": "G2（WI-FI）网关",
      "gatewayType": 1,
      "networkName": "XinHongJia",
      "networkMac": "00:00:00:00:00:00",
      "lockNum": 0,
      "isOnline": 0,
      "version": null,
      "gatewayId": 12
    },
    {
      "serialNumber": "0000000000000000",
      "gatewayMac": "00:00:00:00:00:03",
      "gatewayName": "G2（WI-FI）网关",
      "gatewayType": 1,
      "networkName": "XinHongJia",
      "networkMac": "00:00:00:00:00:00",
      "lockNum": 0,
      "isOnline": 0,
      "version": null,
      "gatewayId": 13
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 2
}

网关-更新

请求链接: /gateway/update
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayId	int	Y	1	网关ID
gatewayName	String	Y	"G2（WI-FI）网关"	网关名称

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-删除

请求链接: /gateway/delete
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayId	int	Y	1	网关ID
isForce	int	N	0	是否强制删除 0否 1是

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-检测网关名称是否重复

请求链接: /gateway/checkGatewayName
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayName	String	Y	""	网关名称

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-检查网关升级

请求链接: /gateway/checkUpgrade
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayId	int	Y	1	网关ID

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-附近的锁（网关连接的锁列表）

请求链接: /gateway/listByLock
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayId	int	Y	1	网关ID

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

json

{
  "list": [
    {
      "lockId": 500,
      "lockAlias": "家庭锁",
      "gatewayRssi": -100
    }
  ],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 1,
  "total": 0
}

说明: gatewayRssi: 网关与锁之间信号强度 0最强 ~ -100无信号

网关-转移网关

请求链接: /gateway/transfer
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayIds	array	Y	[1,2]	网关ID
countryCode	String	N	""	如果存在多账号会返回要求上传区号
receiverUsername	String	Y	"123456@qq.com"	接受者账号

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-确认转移网关

请求链接: /gateway/transferGatewayConfirm
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
countryCode	String	N	""	如果存在多账号会返回要求上传区号
receiverUsername	String	Y	"123456@qq.com"	接受者账号

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-远程开锁

请求链接: /gateway/unlock
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418451"	锁ID

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-扫描设备

请求链接: /gateway/scanDevice
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayId	int	Y	"9418451"	网关ID

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

网关-详情

请求链接: /gateway/detail
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
gatewayId	int	Y	"9418451"	网关ID

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "serialNumber": "0000000000000000",
    "gatewayMac": "00:00:00:00:00:02",
    "gatewayName": "G2（WI-FI）网关",
    "gatewayType": 1,
    "networkName": "XinHongJia",
    "networkMac": "00:00:00:00:00:00",
    "lockNum": 0,
    "isOnline": 0,
    "version": null,
    "gatewayId": 12
  }
}

转移网关确认

请求链接: /plug/transferPlugConfirm
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
type	String	Y	"3"	类型
receiverUsername	String	Y	"18682150237"	接受者账号（原参数名 receiverUserid 已改为 receiverUsername）
countryCode	String	Y	""	如果是手机号，需要选择国家代码

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
uid	Int	用户ID
nickname	String	昵称
headUrl	String	头像URL
userid	String	用户账号

json

{
  "uid": 16474761,
  "nickname": "18682150237",
  "headUrl": "",
  "userid": "18682150237"
}

转移网关

请求链接: /plug/transfer
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
plugIdList	String	Y	"[754013]"	网关ID列表（JSON字符串）
receiverUsername	String	Y	"18682150237"	接受者（原参数名 receiverUserid 已改为 receiverUsername）
uniqueid	String	Y	"477E6814-289D-402A-9F49-F89A8BD05D63"	唯一标识
countryCode	String	Y	""	如果是手机号，需要选择国家代码

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

网关模块 ​

获取网关配置 ​

网关-添加 ​

网关-列表 ​

网关-更新 ​

网关-删除 ​

网关-检测网关名称是否重复 ​

网关-检查网关升级 ​

网关-附近的锁（网关连接的锁列表） ​

网关-转移网关 ​

网关-确认转移网关 ​

网关-远程开锁 ​

网关-扫描设备 ​

网关-详情 ​

转移网关确认 ​

转移网关 ​

网关模块

获取网关配置

网关-添加

网关-列表

网关-更新

网关-删除

网关-检测网关名称是否重复

网关-检查网关升级

网关-附近的锁（网关连接的锁列表）

网关-转移网关

网关-确认转移网关

网关-远程开锁

网关-扫描设备

网关-详情

转移网关确认

转移网关