数据接入说明文档

2020-09-14 阅读量

baseUrl: http://receivercenter.ynjjkj.cn/

本服务用于接收数据采集器所上传的动态数据包括：车辆进出信息、人员进出信息、访客记录信息、人脸抓拍信息以及单位报警信息。采用RestFul风格接口设计、数据传输格式为json。

调用条件：在调用本服务接口前，调用方需要使用账号密码进行登陆，获取到由jwt生成的token令牌以及tenantId；且本文档中除用户登陆之外的所有接口请求的request Head 中，都需加入该token与tenantId，格式分别为：Authorization:token; x-tenant-id:tenantId。此外，该token通过解析之后可得到部分用户信息和token过期时间：exp，格式为时间戳；在设置该token的有效时间时，应当小于exp中的时间。

鉴权机制：本服务使用接口级别的鉴权机制，任何调用本服务数据接口的请求，都会被拦截在数据处理之前进行身份认证和权限认证，如若身份失效亦或是该用户没有接口调用的权限，则会返回对应异常，且不处理该次请求的数据；这样保证了数据的准确性，保证接收到的数据都是授权过的单位或小区所回传的真实信息。

1、用户登陆：

1.1 接口地址（POST）:

1	http://ucenter.ynjjkj.cn/user_center/login

1.2 Body parameters

Name	Type	Description	NotNull	Value
tenantCode	String	租户CODE	Y	BaseData
appCode	String	应用CODE	Y	receive
userName	String	用户名	Y
password	String	密码	Y

1.3 result

Name	Type	Description	NotNull
tenantCode	String	租户CODE	Y
appCode	String	应用CODE	Y
userName	String	用户名	Y
password	String	密码	Y

2、车辆进出信息上传:

2.1 接口地址（POST）:

/carInout

2.2 Body parameters

Name	Type	Description	NotNull
id	String	本地记录ID	Y
communityCode	String	Y
deviceCode	String	设备编码	Y
carNum	String	车牌号	Y
imgPath	String	图片路径	Y
inoutType	Int	进出类型（1进2出）	Y
inoutTime	LocalDateTime	进出时间	Y
driverName	String	驾驶员姓名	N
driverIdCard	String	驾驶员身份证号	N

3、人员进出信息上传:

3.1 接口地址（POST）:

1	/ownerInout

3.2 Body parameters

Name	Type	Description	NotNull
id	String	本地记录ID	Y
communityCode	String	小区编码	Y
deviceCode	String	设备编码	Y
ownerCode	String	业主Code	Y
name	String	人员姓名	Y
idCard	String	人员身份证号	Y
snapImagePath	String	人员照片路径	Y
personalType	Int	人员类型	N
openType	Int	进出方法:1:刷卡 2:呼叫3:动态密码 4:app远程 5:AP热点 6:人脸识别 7:蓝牙开门 8:车牌识别 99:其他	N
inoutType	Int	进出类型（1进2出）	Y
inoutTime	LocalDateTime	进出时间	Y
address	String	地址	N

4、访客信息上传:

4.1 接口地址（POST）:

/visitor

4.2 Body parameters

Name	Type	Description	NotNull
id	String	本地记录ID	Y
communityCode	String	小区编码	Y
deviceCode	String	设备编码	Y
name	String	人员姓名	Y
idCard	String	人员身份证号	Y
phone	String	联系电话	N
visitCase	Int	访问原因	N
address	Int	地址	N
visitTime	LocalDateTime	访问时间	Y
visitObject	Int	访问对象	N
photoPath	String	抓拍照片路径	Y
idCardPhotoPath	String	身份证照片路径	N

5、人脸抓拍信息上传:

5.1 接口地址（POST）:

/faceSnap

5.2 Body parameters

Name	Type	Description	NotNull
id	String	本地记录ID	Y
communityCode	String	小区编码	Y
deviceCode	String	设备编码	Y
imgPath	String	人脸抓拍图片路径	Y
snapTime	LocalDateTime	抓拍时间	Y
idCard	String	被抓拍人身份证号	N
name	String	被抓拍人姓名	N

6、报警信息上传:

6.1 接口地址（POST）:

/alarm

6.2 Body parameters

Name	Type	Description	NotNull
id	String	本地记录ID	Y
communityCode	String	小区编码	Y
deviceCode	String	设备编码	Y
content	String	报警内容	Y
alarmTime	LocalDateTime	报警时间	Y
communityName	String	单位名称	Y
handleUser	String	报警处理人	N
handleTime	LocalDateTime	处理时间	N
location	String	安装地址	Y
type	Int	报警设备类型	N