一卡通云管控平台接口规范说明

目录

1. 接口注意事项

1. 数据提交基于JSON的方式

2. 数据提交基于HTTPS实现单向认证和加密

3. 数据提交需通过 HTTPS POST的方式；

4. 系统提供基于 JWT 的身份验证，接入程序需判断token 的有效性，当token 过期时需自行实现重新登录；

5. 测试账号：test/test

2. 登录获取Token

1. Url：https://ip:port/ccp/login

2. methodType：POST

3. 提交访客及住户进出数据

1. Header：auth_token：TOKEN

2. Url：https://ip:port/ccp/saveVisitorRecord

3. methodType：POST

4. 提交车辆进出记录

1. Header：auth_token：TOKEN;

2. Url：https://ip:port/api/saveVehicleAccessRecord

3. methodType：POST

5. 系统状态代码说明

1. 接口注意事项

1. 数据提交基于JSON的方式

2. 数据提交基于HTTPS实现单向认证和加密

3. 数据提交需通过 HTTPS POST的方式；

4. 系统提供基于 JWT 的身份验证，接入程序需判断token 的有效性，当token 过期时需自行实现重新登录；

5. 测试账号：test/test

6. 测试地址：https://47.95.113.188:8443/ccp

2. 登录获取Token

先登录获取Token，后期所有接口需在Header中添加Token信息，否则接口不能通过

1. Url：https://ip:port/ccp/login

methodType：POST

参数:

参数名	字段名	字段类型	长度	是否必填	说明
username	用户名	String	12	必填	用户名
password	密码	String	18	必填	密码

返回：

参数名	字段名	字段类型	说明
error_code	错误号	String	0为成功，其他则为失败（对应状态码说明）
error_message	错误信息	String	文字信息，UTF8
token	Token	String	加密Token

3. 提交访客及住户进出数据

1. Header：auth-token：TOKEN

Url：https://ip:port/ccp/save VisitorRecord

methodType：POST

参数:

参数名	字段名	字段类型	长度	是否必填	说明
XM	姓名	String	18	必填	姓名
SFZH	身份证号	String	18	必填	身份证号
TYPE	人员标识	INTGER	1	必填	0：访客，1：住户
JCSJ	进出时间	DateTime		必填	YYYY-MM-dd HH:mm:ss
XZQH	行政区划	String	24	必填	行政区划
SSFXSJDM	数据所属分县市局代码	String	12	必填	Excel对照表查询
SSFXSJMC	数据所属分县市局名称	String	120	必填	Excel对照表查询
SSPCSDM	数据所属派出所代码	String	12	必填	Excel对照表查询
SSPCSMC	数据所属派出所名称	String	120	必填	Excel对照表查询
ZP	照片信息	String	2MB		Jpg格式，使用base64转码传输
INFO[ZHXX]	住户信息	Object			详细信息见下方附表
INFO[FKXX]	访客信息	Object			详细信息见下方附表
INFO[LDXX]	楼栋信息	Object			详细信息见下方附表
INFO[FJXX]	房间信息	Object			详细信息见下方附表

附：访客信息

参数名	字段名	字段类型	说明
FKXM	访客姓名	String
FKSFZH	访客身份证号	String
FWSY	访问事由	String
FWSJ	访问时间	Date
FWR	被访问人	String
…	其他	String	允许有其他信息，将一并保存，

附：住户信息

参数名	字段名	字段类型	说明
SSLD	所属楼栋	String
SSFJ	所属房间	String
ZHLX	住户类型	String	业主01、业主家人02、租客03
YZXM	业主姓名	String
CSNY	出生年月	String
SFZHM	身份证号码	String
NCBM	昵称别名	String
JTJS	家庭角色	String	男主人、女主人、儿子、女儿、爸爸、妈妈、…
XB	性别	String	男01、女02
SJHM	手机号码	String
…	其他	String	允许有其他信息，将一并保存，

附：房间信息

参数名	字段名	字段类型	说明
FJMC	房间名称	String
SSLD	所属楼栋	String
DYH	单元号	String
BZ	备注	String
…	其他	String	允许有其他信息，将一并保存，

附：楼栋信息表

参数名	字段名	字段类型	说明
LDMC	楼栋名称	String
DMCS	地面层数	Number
DXCS	地下层数	Number
LDH	楼栋号	String
BZ	备注	String
…	其他	String	允许有其他信息，将一并保存，

返回：

参数名	字段名	字段类型	说明
error_code	错误号	String	0为成功，其他则为失败（对应状态码说明）
error_message	错误信息	String	文字信息，UTF8

4. 提交车辆进出记录

1. Header：auth-token：TOKEN;

Url：https://ip:port/ccp/saveVehicleAccessRecord

methodType：POST

参数

参数名	字段名	字段类型	长度	是否必填	说明
TYPE	进出标记	INTEGER	4	必填	0:进场 1:出场
SJ	进出时间	DateTime		必填	进出时间 YYYY-MM-dd HH:mm:ss UTC+08:00
TCCM	停车场名	String	128	必填
CLHP	车辆号牌	String	10	必填
XZQH	行政区划	String	24	必填	行政区划
SSFXSJDM	数据所属分县市局代码	String	12	必填	Excel对照表查询
SSFXSJMC	数据所属分县市局名称	String	120	必填	Excel对照表查询
SSPCSDM	数据所属派出所代码	String	12	必填	Excel对照表查询
SSPCSMC	数据所属派出所名称	String	120	必填	Excel对照表查询
ZP	照片信息	String	2MB		Jpg格式，使用base64转码传输

返回：

参数名	字段名	字段类型	说明
error_code	错误号	String	0为成功，其他则为失败（对应状态码说明）
error_message	错误信息	String	文字信息，UTF8

5. 系统状态代码说明

Code	MSG
0	成功
-1	进出者姓名为空
-2	进出者身份证号为空
-3	进出人员类型错误
-4	进出时间为空
-5	车辆进出标记错误
-6	停车场名为空
-7	车辆号牌为空
-999	保存失败
-401	未获取到TOKEN
-402	TOKEN过期
-404	用户名或密码为空