接口列表
本节包含客流统计相关接口等。
接口列表如下:
序号 | 接口功能 | 描述 |
---|---|---|
1 | 获取客流统计开关状态 | 查询指定设备客流统计开关状态 |
2 | 设置客流统计开关 | 设置设备客流统计开关状态 |
3 | 查询设备某一天的统计客流数据 | 查询设备某一天总的客流数据 |
4 | 查询设备某一天每小时的客流数据 | 查询设备某一天每小时的客流数据 |
5 | 配置客流统计信息 | 配置客流统计信息 |
6 | 获取客流统计配置信息 | 获取客流统计配置信息 |
获取客流统计开关状态
接口功能
该接口用于获取客流统计开关状态(接口需要设备支持客流统计功能)
请求地址
https://open.ys7.com/api/lapp/passengerflow/switch/status
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
- HTTP请求报文
POST /api/lapp/passengerflow/switch/status HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.47egoa5iazk02hcn73sepv2q12x8ulsx&deviceSerial=427734888
- 返回数据
{
"data": {
"deviceSerial": "427734888",
"channelNo": 0,
"enable": 0
},
"code": "200",
"msg": "操作成功!"
}
- 返回字段
字段名 | 类型 | 描述 |
---|---|---|
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 |
channelNo | int | 通道号 |
enable | int | 状态:0-关闭,1-开启 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10004 | 用户不存在 | |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
49999 | 数据异常 | 接口调用异常 |
60020 | 不支持该命令 | 设备不支持客流统计功能 |
设置客流统计开关
接口功能
该接口用于设置客流统计开关(接口需要设备支持客流统计功能)
请求地址
https://open.ys7.com/api/lapp/passengerflow/switch/set
请求方式
POST
子账户token请求所需最小权限
"Permission":"Config"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
enable | int | 状态:0-关闭,1-开启 |
Y |
channelNo | int | 通道号,不传表示设备本身 | N |
- HTTP请求报文
POST /api/lapp/passengerflow/switch/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=596510888&enable=1&channelNo=1
- 返回数据
{
"code": "200",
"msg": "操作成功!"
}
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20006 | 网络异常 | 检查设备网络状况,稍后再试 |
20007 | 设备不在线 | 检查设备是否在线 |
20008 | 设备响应超时 | 操作过于频繁,稍后再试 |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
20032 | 该用户下通道不存在 | 该用户下通道不存在 |
49999 | 数据异常 | 接口调用异常 |
60020 | 不支持该命令 | 设备不支持客流统计功能 |
60022 | 已是当前状态 | 已是当前开关状态 |
查询设备某一天的统计客流数据
接口功能
该接口用于查询设备某一天的客流统计数据(接口需要设备支持客流统计功能)
请求地址
https://open.ys7.com/api/lapp/passengerflow/daily
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"Cam:序列号:通道号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
channelNo | int | 通道号 | Y |
date | long | 时间戳日期,精确至毫秒,默认为今天 ,date参数只能是0时0点0分0秒(如1561046400000可以,1561050000000不行) |
N |
注意:当天的数据会在第二天凌晨2点左右更新,获取前一天的数据只能在第二天的2点之后才能获取到。
- HTTP请求报文
POST /api/lapp/passengerflow/daily HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=596510666&channelNo=1&date=146744312353
- 返回数据
{
"data": {
"inFlow": 1000,
"outFlow": 1000
},
"code": "200",
"msg": "操作成功!"
}
- 返回字段
字段名 | 类型 | 描述 |
---|---|---|
inFlow | int | 进店流量 |
outFlow | int | 出店流量 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
20032 | 该用户下通道不存在 | 该用户下通道不存在 |
49999 | 数据异常 | 接口调用异常 |
60020 | 不支持该命令 | 设备不支持客流统计功能 |
查询设备某一天每小时的客流数据
接口功能
该接口用于查询设备某一天每小时的客流统计数据(接口需要设备支持客流统计功能)
请求地址
https://open.ys7.com/api/lapp/passengerflow/hourly
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"Cam:序列号:通道号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
channelNo | int | 通道号 | Y |
date | long | 时间戳日期,精确至毫秒,默认为今天 |
N |
- HTTP请求报文
POST /api/lapp/passengerflow/hourly HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=596510666&channelNo=1&date=146744312353
- 返回数据
{
"data": [
{
"hourIndex": 0,
"inFlow": 23,
"outFlow": 32
},
{
"hourIndex": 1,
"inFlow": 12,
"outFlow": 41
}
],
"code": "200",
"msg": "操作成功!"
}
- 返回字段
字段名 | 类型 | 描述 |
---|---|---|
hourIndex | int | 小时索引 |
inFlow | int | 进店流量 |
outFlow | int | 出店流量 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
20032 | 该用户下通道不存在 | 该用户下通道不存在 |
49999 | 数据异常 | 接口调用异常 |
60020 | 不支持该命令 | 设备不支持客流统计功能 |
配置客流统计信息
接口功能
该接口用于配置客流统计相关信息(接口需要设备支持客流统计功能)
请求地址
https://open.ys7.com/api/lapp/passengerflow/config/set
请求方式
POST
子账户token请求所需最小权限
"Permission":"Config"
"Resource":"Cam:序列号:通道号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
line | String | 统计线的两个坐标点,坐标范围为0到1之间的7位浮点数,(0,0)坐标在左上角,格式如{"x1": "0.0","y1": "0.5","x2": "1","y2": "0.5"} | Y |
direction | int | 指示方向的两个坐标点,(x1,y1)为起始点,(x2,y2)为结束点格式如{"x1": "0.5","y1": "0.5","x2": "0.5","y2": "0.6"},最好与统计线保持垂直 | Y |
channelNo | int | 非必选参数,不为空表示配置指定通道客流统计信息,为空表示配置设备本身信息 | N |
- HTTP请求报文
POST /api/lapp/passengerflow/config HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888&line=%7B%22x1%22%3A+%220.0%22%2C%22y1%22%3A+%220.5%22%2C%22x2%22%3A+%220.5%22%2C%22y2%22%3A+%220.5%22%7D&direction=%7B%22x1%22%3A+%220.5%22%2C%22y1%22%3A+%220.5%22%2C%22x2%22%3A+%220.5%22%2C%22y2%22%3A+%220.6%22%7D
- 返回数据
{
"code": "200",
"msg": "操作成功!"
}
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10004 | 用户不存在 | |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20006 | 网络异常 | 检查设备网络状况,稍后再试 |
20007 | 设备不在线 | 检查设备是否在线 |
20008 | 设备响应超时 | 操作过于频繁,稍后再试 |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
20032 | 该用户下通道不存在 | 该用户下通道不存在 |
49999 | 数据异常 | 接口调用异常 |
60020 | 不支持该命令 | 设备不支持客流统计功能 |
60022 | 已是当前状态 | 已是当前开关状态 |
60025 | 客流统计配置失败 | 设备返回其他错误码 |
获取客流统计配置信息
接口功能
该接口用于获取客流统计配置相关信息(接口需要设备支持客流统计功能)
请求地址
https://open.ys7.com/api/lapp/passengerflow/config/get
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"Cam:序列号:通道号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
channelNo | int | 非必选参数,不为空表示获取指定通道客流统计配置信息,为空表示获取设备本身配置信息 | N |
- HTTP请求报文
POST /api/lapp/passengerflow/config/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888
- 返回数据
{
"data": {
"line": {
"x1": "0.5000000",
"y1": "0.0000000",
"x2": "0.5000000",
"y2": "1.0000000"
},
"direction": {
"x1": "0.5000000",
"y1": "0.5000000",
"x2": "0.2500000",
"y2": "0.5000000"
}
},
"code": "200",
"msg": "操作成功!"
}
- 返回字段
字段名 | 类型 | 描述 |
---|---|---|
line | Object | 统计线的两个坐标点,坐标范围为0到1之间的7位浮点数,(0,0)坐标在左上角,格式如{"x1": "0.0","y1": "0.5","x2": "1","y2": "0.5"} |
direction | Object | 指示方向的两个坐标点,(x1,y1)为起始点,(x2,y2)为结束点格式如{"x1": "0.5","y1": "0.5","x2": "0.5","y2": "0.6"},与统计线保持垂直 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken异常或过期 | 重新获取accessToken |
10004 | 用户不存在 | |
10005 | appKey异常 | appKey被冻结 |
20002 | 设备不存在 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | 检查设备是否属于当前账户 |
20032 | 该用户下通道不存在 | 该用户下通道不存在 |
49999 | 数据异常 | 接口调用异常 |
60020 | 不支持该命令 | 设备不支持客流统计功能 |
60022 | 已是当前状态 | 已是当前开关状态 |