1 事件列表
event 取值 | 说明 |
---|---|
1010 | IPC FM010 动态侦测消息 |
1011 | IPC上线消息通知 |
1012 | IPC下线消息通知 |
1100 | 向指定人脸分组添加人脸信息的结果推送消息 |
2001 | IPC实时获取人员消息 |
2 事件消息示例
2.1 IPC FM010 动态侦测消息 (event=1010)
报文格式: application/x-www-form-urlencoded;param=value;charset=UTF-8
消息体格式:
{
"app_id": 'CSJGYI6T8P237', //唯一标识接入身份,联系商米数字店铺提供
"event": '1010', // 触发消息的类型
"payload": '{
"ipc_id": 029388,
"sn": "FS101D8BS00080",
"name": "设备1",
"video_url": "http://xxx.xxx.xxx.xxx/xxx/xxx/41b061f6f10dbd6fe1aaf469fb0ab012d9193d9655816af31cdfbcsdfe71a5fe1",
"model_name": "FM020",
"motion_type": 1
}',
"random": 'NDL8GXR', // 随机字符串,由数字和字母组成,长度范围为6-10位
"shop_id": '29203', // 店铺在SaaS软件体系下的唯一标识, 没有或者不需要则为空
"sign": '738D9FF2482D59E5DC1FB32B6F445464', //签名校验
"sunmi_shop_no": '28393437387', // 商米数字店铺平台门店唯一编号, 没有或者不需要则为空
"timestamp": '1604567375' //当前的unix timestamp,精度到秒级,10位数字
}
字段描述:motion_type
motion_type取值 | 说明 |
---|---|
1 | 视频侦测事件 |
2 | 声音侦测事件 |
2.2 IPC上线消息通知 (event=1011)
报文格式: application/x-www-form-urlencoded;param=value;charset=UTF-8
消息体格式:
{
"app_id": 'CSJGYI6T8P237', //唯一标识接入身份,联系商米数字店铺提供
"event": '1011', // 触发消息的类型
"payload": '{
"ipc_id": "549755811676",
"ipc_name": "摄像头设备1",
"ipc_sn": "FS101D8BS00080",
"online_time": 1576415912
}',
"random": 'NDL8GXR', // 随机字符串,由数字和字母组成,长度范围为6-10位
"shop_id": '29203', // 店铺在SaaS软件体系下的唯一标识, 没有或者不需要则为空
"sign": '738D9FF2482D59E5DC1FB32B6F445464', //签名校验
"sunmi_shop_no": '28393437387', // 商米数字店铺平台门店唯一编号, 没有或者不需要则为空
"timestamp": '1604567375' //当前的unix timestamp,精度到秒级,10位数字
}
2.3 IPC下线消息通知 (event=1012)
报文格式: application/x-www-form-urlencoded;param=value;charset=UTF-8
消息体格式:
{
"app_id": 'CSJGYI6T8P237', //唯一标识接入身份,联系商米数字店铺提供
"event": '1012', // 触发消息的类型
"payload": '{
"ipc_id": "549755811676",
"ipc_name": "摄像头设备1",
"ipc_sn": "FS101D8BS00080",
"offline_time": 1576415912
}',
"random": 'NDL8GXR', // 随机字符串,由数字和字母组成,长度范围为6-10位
"shop_id": '29203', // 店铺在SaaS软件体系下的唯一标识, 没有或者不需要则为空
"sign": '738D9FF2482D59E5DC1FB32B6F445464', //签名校验
"sunmi_shop_no": '28393437387', // 商米数字店铺平台门店唯一编号, 没有或者不需要则为空
"timestamp": '1604567375' //当前的unix timestamp,精度到秒级,10位数字
}
2.4 向指定人脸分组添加人脸信息的结果推送消息 (event=1100)
报文格式: application/x-www-form-urlencoded;param=value;charset=UTF-8
消息体格式:
{
"app_id": 'CSJGYI6T8P237', //唯一标识接入身份,联系商米数字店铺提供
"event": '1100', // 触发消息的类型
"payload": '{
"code": 0, /*其他错误参考下方字段描述 */
"msg": "",
"face_id": "235698745612",
}',
"random": 'NDL8GXR', // 随机字符串,由数字和字母组成,长度范围为6-10位
"shop_id": '29203', // 店铺在SaaS软件体系下的唯一标识, 没有或者不需要则为空
"sign": '738D9FF2482D59E5DC1FB32B6F445464', //签名校验
"sunmi_shop_no": '28393437387', // 商米数字店铺平台门店唯一编号, 没有或者不需要则为空
"timestamp": '1604567375' //当前的unix timestamp,精度到秒级,10位数字
}
字段描述
code | 说明 |
---|---|
5527 | 不合格的人脸照片 |
5000 | 数据库错误 |
2.5 IPC实时获取人员消息 (event=2001)
报文格式: application/x-www-form-urlencoded;param=value;charset=UTF-8
消息体格式:
{
"app_id": 'CSJGYI6T8P237', //唯一标识接入身份,联系商米数字店铺提供
"event": '2001', // 触发消息的类型
"payload": '{
"ipc_id": "512369745691",
"ipc_sn": "FS101D8BS00080",
"face_id": "235698745612",
"gender": 1,
"age_range": 4,
"face_image_url": "https://xxxxxx/IMG/FACE/NKO62XI9PJ4MJX9HJNZ0VOTX863LKBV0?auth_key=1585224994-EULH8E2CXI-0-8ba0ee794d1f4a08c9134898d3013938", //有效期为一天
"group_id": "8927",
"group_name": "stranger",
"group_type": 2,
"member_id": "2938203938", //如果获取的人员为录入会员,则返回会员id,非会员,则返回为""
}',
"random": 'NDL8GXR', // 随机字符串,由数字和字母组成,长度范围为6-10位
"shop_id": '29203', // 店铺在SaaS软件体系下的唯一标识, 没有或者不需要则为空
"sign": '738D9FF2482D59E5DC1FB32B6F445464', //签名校验
"sunmi_shop_no": '28393437387', // 商米数字店铺平台门店唯一编号, 没有或者不需要则为空
"timestamp": '1604567375' //当前的unix timestamp,精度到秒级,10位数字
}
字段描述
gender 取值 | 说明 |
---|---|
0 | 未知 |
1 | 男 |
2 | 女 |
age_range 取值 | 说明 |
---|---|
1 | 0~6岁 |
2 | 7~12岁 |
3 | 13~18岁 |
4 | 19~28岁 |
5 | 29~35岁 |
6 | 36~45岁 |
7 | 46~55岁 |
8 | 56~ 岁 |
group_type 取值 | 说明 |
---|---|
1 | 生客人脸库 |
2 | 熟客人脸库 |
3 | 店员人脸库 |
5 | 自定义人脸库 |
附录:签名sign生成规则
2.1 协议说明
对接的openAPI接口目前只开放HTTPS方式,所有的消息一律采用POST方式。
2.2 签名规则
对于所有的接入者,数字店铺开放平台会分配以下内容:
- app_id: 唯一标识接入身份
- secret_key: 该用户独有的签名校验
签名规则应用于对HTTP请求中的参数进行MD5签名,规则顺序如下:
- 参数必须包含random字段,为一个随机字符串,由数字和字母组成,长度范围为6-10位
- 参数必须包含timestamp字段 ,为当前的unix timestamp,精度到秒级,10位数字, 格式可以参考 https://tool.chinaz.com/tools/unixtime.aspx
- 参数必须包含app_id字段
- 首先对于所有包含key的传递参数按照ASCII码顺序从小到大排序,将key-value键值对依此组成字符串 (文件参数不参与验签)
- 在字符串尾部拼接该SaaS厂商独有的签名校验secret_key值,拼接方法见例子详述
- 对字符串进行MD5签名
- 对生成的MD5签名转化为全大写
