2.1 接口描述
设备管理接口用来管理智能摄像机设备的基本属性,比如名称等。
2.2 接口列表
接口名称 | 接口描述 |
---|---|
/device/ipc/getList | 获取设备列表 |
/device/ipc/getListByCompany | 获取商铺下所有设备列表 |
/device/ipc/getInfo | 获取设备基本信息 |
/device/ipc/updateName | 修改设备名称 |
/device/ipc/bind | 绑定设备 |
/device/ipc/unbind | 解绑设备 |
2.3 接口详情
2.3.1 获取设备列表
接口描述:通过本接口调用,用户可以获取相关门店下所有设备列表。
请求链接:/device/ipc/getList
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台唯一编号(v2.0之后为必填项) | 560279010307 |
shop_id | 否 | string | 店铺在SaaS体系下的唯一标识(此参数为后向兼容v2.0之前版本的字段,在v2.0及以后版本使用sunmi_shop_no替代,作为门店唯一标识即可) | 10096 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/device/ipc/getList",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1581333970,
"random": "5dsf6698",
"sign": "5EA14F9445D72DDE113AA95B04797D29"
}
返回值:
{
"data": {
"total_count": 1,
"ipc_list": [
{
"ipc_id": "549755805878",
"ipc_sn": "C101P98200023",
"ipc_name": "小松松大魔王",
"model_name": "FM010",
"software_version": "1.2.6",
"check_version_time": 1566365781,
"connect_time": 1565951330,
"active_status": 0,
"screenshot_url": "https://xxxxxxxx/IMG/IPC/e36654e8a95a9ad27b5bb585a0f7df50a0de0dd6e0aeaee47b4e34c4f4636f9a"
}
]
},
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed"
}
返回字段描述:active_status
active_status 取值 | 说明 |
---|---|
0 | 设备离线 |
1 | 设备在线 |
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5013 | 未查询到数据 |
5041 | 请求中未找到shop_id参数 |
2.3.2 获取设备基本信息
接口描述:通过本接口调用,用户可以获取指定设备基本信息。
请求链接:/device/ipc/getInfo
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台唯一编号(v2.0之后为必填项) | 560279010307 |
shop_id | 否 | string | 店铺在SaaS体系下的唯一标识(此参数为后向兼容v2.0之前版本的字段,在v2.0及以后版本使用sunmi_shop_no替代,作为门店唯一标识即可) | 10096 |
ipc_id | 否 | string | 摄像机设备唯一ID(与ipc_sn必出现其一,若同时输入,必须一致) | 549755805878 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
请求示例 :
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/device/ipc/getInfo",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"ipc_id": "549755805878",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1581333970,
"random": "5dsf6698",
"sign": "140E3195C0F00DB09457E015AA79D79B"
}
返回值:
{
"data": {
"ipc_id": "549755805878",
"ipc_sn": "C101P98200023",
"ipc_name": "小松松大魔王",
"model_name": "FM010",
"software_version": "1.2.6",
"check_version_time": 1566365781,
"connect_time": 1565951330,
"active_status": 0,
"screenshot_url": "https://xxxxxxxx/IMG/IPC/e36654e8a95a9ad27b5bb585a0f7df50a0de0dd6e0aeaee47b4e34c4f4636f9a"
},
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed"
}
返回字段描述:active_status
active_status 取值 | 说明 |
---|---|
0 | 设备离线 |
1 | 设备在线 |
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5013 | 未找到数据 |
5041 | 请求中未找到shop_id参数 |
5501 | ipc设备不存在 |
2.3.3 修改设备名称
接口描述:通过本接口调用,用户可以修改设备名称。
请求链接:/device/ipc/updateName
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台唯一编号(v2.0之后为必填项) | 560279010307 |
shop_id | 否 | string | 店铺在SaaS体系下的唯一标识(此参数为后向兼容v2.0之前版本的字段,在v2.0及以后版本使用sunmi_shop_no替代,作为门店唯一标识即可) | 10096 |
ipc_id | 否 | string | 摄像机设备唯一ID 摄像机SN(与ipc_sn必出现其一, 若同时输入,必须一致 | 549755805878 |
ipc_sn | 否 | string | 摄像机SN(与ipc_id必出现其一, 若同时输入,必须一致 ) | C101P98200023 |
ipc_name | 是 | string | 修改的新设备名称 | 示例设备 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/device/ipc/updateName",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"ipc_id": "549755805878",
"ipc_name": "示例设备",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1581333970,
"random": "5dsf6698",
"sign": "140E3195C0F00DB09457E015AA79D79B"
}
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {}
}
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5011 | 与设备通讯错误 |
5013 | 未找到数据 |
5041 | 请求中未找到shop_id参数 |
5501 | ipc设备不存在 |
5506 | 数据库中未找到该ipc设备信息 |
5510 | 设备未绑定 |
2.3.4 绑定设备
接口描述:通过本接口调用,用户可以绑定指定设备。
请求链接:/device/ipc/bind
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
sunmi_shop_no | 否 | string | 商米数字店铺平台唯一编号(v2.0之后为必填项) | 560279010307 |
shop_id | 否 | string | 店铺在SaaS体系下的唯一标识(此参数为后向兼容v2.0之前版本的字段,在v2.0及以后版本使用sunmi_shop_no替代,作为门店唯一标识即可) | 10096 |
ipc_sn | 是 | string | 摄像机设备SN号 | C101D96U00034 |
mac | 是 | string | 摄像机设备mac地址 | 0C25766F5705 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/device/ipc/bind",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"ipc_sn": "C201D8BS00089",
"mac":"0C25766F5705",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回示例:
{
"data": {},
"code": 0,/* 其他错误参考错误列表 */
"msg": "succeed"
}
错误码:
错误码 | 说明 |
5000 | 数据库错误 |
5013 | 未找到数据 |
5020 | 无效参数 |
5041 | 请求中未找到shop_id参数 |
5079 | 无效mac地址 |
5501 | 设备不存在 |
5509 | 设备被绑定 |
2.3.5 解绑设备
接口描述:通过本接口调用,用户可以解绑指定设备。
请求链接:/device/ipc/unbind
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
sunmi_shop_no | 否 | string | 商米数字店铺平台唯一编号(v2.0之后为必填项) | 560279010307 |
shop_id | 否 | string | 店铺在SaaS体系下的唯一标识(此参数为后向兼容v2.0之前版本的字段,在v2.0及以后版本使用sunmi_shop_no替代,作为门店唯一标识即可) | 10096 |
ipc_sn | 否 | string | 摄像机设备SN号(ipc_sn与ipc_id有其一即可) | C101D96U00034 |
ipc_id | 否 | string | 摄像机设备唯一ID(ipc_sn与ipc_id有其一即可) | 549755805878 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/device/ipc/unbind",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_shop_no": "560279010307",
"ipc_sn": "C201D8BS00089",
"ipc_id":"549755805878",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1578972864,
"random": "5dsf6698",
"sign": "33C18A18282733A71F998BB5A5E4319D"
}
返回示例:
{
"data": {},
"code": 0,/* 其他错误参考错误列表 */
"msg": "succeed"
}
错误码:
错误码 | 说明 |
5000 | 数据库错误 |
5013 | 未查询到数据 |
5020 | 无效参数 |
5041 | 请求中未找到shop_id参数 |
5501 | 设备不存在 |
5510 | 设备未绑定 |
2.3.6 获取商户下设备列表
接口描述:通过本接口调用,用户可以获取相关门店下所有设备列表。
请求链接:/device/ipc/getListByCompany
接口版本:v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
sunmi_company_no | 是 | string | 商米数字商户唯一编号(v2.0之后为必填项) | 560279010307 |
请求示例:
"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/device/ipc/getListByCompany",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
formData: {
"sunmi_company_no": "560279010307",
"app_id": "LMWWQVTW4QGCC",
"timestamp": 1581333970,
"random": "5dsf6698",
"sign": "5EA14F9445D72DDE113AA95B04797D29"
}
返回值:
{
"data": {
"total_count": 1,
"ipc_list": [
{
"ipc_id": "549755811632",
"ipc_sn": "C101E96500011",
"ipc_name": "My Camera",
"model_name": "FM010",
"software_version": "1.0.0",
"active_status": 1
}
]
},
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed"
}
返回字段描述:active_status
active_status 取值 | 说明 |
---|---|
0 | 设备离线 |
1 | 设备在线 |
错误码:
错误码 | 说明 |
---|---|
5000 | 数据库错误 |
5041 | 绑定关系有问题 |
5013 | 未查询到数据 |