一、接口对接步骤
1. 接入申请
各上报单位向管理部门申请数据接入,获得授权后,向指定网络地址上报数据。管理部门审核通过后发放获取令牌接口的参数,使用令牌调用相关数据上报接口进行数据上报。
各上报单位和各管理系统申请接入审核通过后获得分配以下参数:
参数名称 | 参数描述 |
---|---|
appId | appId(即调用获取令牌接口的 appid) |
appSecret | appsecret(即获取令牌时的参数 secret) |
2. 获取令牌
http请求方式:
GET接口地址:
/api/token?grant_type=client_credential&Appid=appId&Secret=appSecret
3. 发起请求
上报接口采用HTTP协议,POST方式提交,字符编码UTF-8。
其中HEADER部分传递access_token值通过参数Authorization传输,Body部分传递接口业务参数,业务参数以json对象格式拼接。
二、客流相关接口详情
1. 二维码签到系统数据接口
- 数据上传说明:
数据按上报频率要求上报,数据为当天每个时间段(以小时为单位)。统计场馆符合要求扫码打卡的人数。例如:18:00 代表17:00-18:00这个时间段场馆的进场人数。 - 接口地址:
/api/customerflow/syncQRCodeFlowData
2. 双目摄像头系统数据接口
- 数据上传说明:
数据按上报频率要求上报,数据为当天每个时间段(以小时为单位)入场人数的统计数据, 例如:18:00 代表17:00-18:00这个时间段场馆的进场人数。 - 接口地址:
/api/customerflow/syncBinocularFlowData
3. 人工智能视频识别系统数据接口
- 数据上传说明:
数据按上报频率要求上报,数据为当天每个时间段(以小时为单位),分别对场馆不同行为模式的人进行计数。 - 接口地址:
/api/customerflow/syncAIVSFlowData
4. 运营商地理位置服务系统数据接口
- 数据上传说明:
数据按上报频率要求上报统计进出场馆的人数。客流数据要按不低于1次/日统计上传。 - 接口地址:
/api/customerflow/syncOperatorsFlowData
5. 人脸识别系统数据接口
- 数据上传说明:
数据按上报频率不大于60分钟要求上报,数据为当天每个时间段(以小时为单位)入场人数的统计数据,例如:18:00 代表17:00-18:00这个时间段场馆的进场人数 - 接口地址:
/api/customerflow/syncFaceRecognitionFlowData
6. 闸机系统-人脸识别数据接口
- 数据上传说明:
数据按上报频率要求上报,数据为通过门禁/闸机入场的客流明细,需要准确的入场时间。 - 接口地址:
/api/customerflow/syncGatebrakeFlowData
7. 闸机系统-刷卡扫码数据接口
- 数据上传说明:
数据按上报频率不大于60分钟要求上报,数据为通过刷卡设备或者扫码设备入场的客流明 细,需要上报准确的入场时间. - 接口地址:
/api/customerflow/syncGardScrnningcodeFlowData
8. 每日汇总客流量推送接口(包含低免和非低免全部区域的总客流量)
- 数据上传说明:
每天23点50汇总当日进出客流量推送。 - 接口地址:
/api/customerflow/syncTotalCountFlowData
9. 每周汇总客流量推送接口(包含低免和非低免全部区域的总客流量)
- 数据上传说明:
每周最后一天23点50汇总本周一至周日进出客流量推送。 - 接口地址:
/api/customerflow/syncTotalWeekCountFlowData
10. 每月汇总客流量推送接口
- 数据上传说明:
每月最后一天23点50汇总本月进出客流量推送。 - 接口地址:
/api/customerflow/syncTotalMonthFlowData
11. 核心免低区域-每日汇总客流量推送接口
- 数据上传说明:
每天23点50汇总当日进出客流量推送。 - 接口地址:
/api/customerflow/syncFreeOfCharge
12. 核心免低区域-每周汇总客流量推送接口
- 数据上传说明:
每天23点50汇总当日进出客流量推送。 - 接口地址:
/api/customerflow/syncFreeOfCharge
13. 核心免低区域-每月汇总客流量推送接口
- 数据上传说明:
每月最后一天23点50汇总本月进出客流量推送。 - 接口地址:
/api/customerflow/syncMonthFreeOfCharge
14. 场馆设备信息推送
- 数据上传说明:
推送场馆内所有的点位设备(摄像头)信息。 - 接口地址:
/api/customerflow/syncEquipmentData
15. 场馆低免区域坐标信息推送
- 数据上传说明:
推送场馆的低免区域的坐标信息。 - 接口地址:
/api/customerflow/syncVenueFreeArea