目录
目录
1 目途 5
2 通信协议 5
3 API接口 5
31 户登录 5
311 功说明 5
312 接口定义 5
313 请求参数示例 6
314 响应结果示例 6
32 获取户信息 6
321 功说明 6
322 接口定义 6
323 请求参数示例 7
324 响应结果示例 7
33 刷新户状态 7
331 功说明 7
332 接口定义 8
333 请求参数示例 8
334 响应结果示例 8
34 修改密码 9
341 功说明 9
342 接口定义 9
343 请求参数示例 9
344 响应结果示例 9
35 获取停车场 10
351 功说明 10
352 接口定义 10
353 请求参数示例 10
354 响应结果示例 11
36 获取岗亭列表 11
361 功说明 11
362 接口定义 11
363 请求参数示例 12
364 响应结果示例 12
37 获取车道 13
371 功说明 13
372 接口定义 13
373 请求参数示例 14
374 响应结果示例 14
38 计费接口 15
381 功说明 15
382 接口定义 15
383 请求参数示例 16
384 响应结果示例 16
39 保存入场信息 17
391 功说明 17
392 接口定义 17
393 请求参数示例 17
394 响应结果示例 18
310 获取场车辆 18
3101 功说明 18
3102 接口定义 18
3103 请求参数示例 19
3104 响应结果示例 19
311 保存出场信息 20
3111 功说明 20
3112 接口定义 20
3113 请求参数示例 21
3114 响应结果示例 21
312 保存支付订单 21
3121 功说明 21
3122 接口定义 21
3123 请求参数示例 22
3124 响应结果示例 22
313 传图片 22
3131 功说明 22
3132 接口定义 22
3133 请求参数示例 22
3134 响应结果示例 23
314 获取参数 23
3141 功说明 23
3142 接口定义 23
3143 请求参数示例 23
3144 响应结果示例 24
315 获取数字典 24
3151 功说明 24
3152 接口定义 24
3153 请求参数示例 25
3154 响应结果示例 25
4 MQ接口 26
41 通行数实时传 26
411 功说明 26
412 接口定义 26
413 请求参数示例 27
1 目途
2 通信协议
接口采 HTTP 协议支持 GET POST 请求方式(具体接口参见接口定义)
请求头需包含编码描述: ContentTypeapplicationxwwwformurlencodedcharsetutf8 POST 请求时容示例 header POST 接口址 HTTP11 ContentTypeapplicationxwwwformurlencodedcharsetutf8
body merchant_no9827c6b5c6d94485b912b6e90c92a7ae&time_stamp20170328172011&signA3DE1813F4DDBADFC18555E18A2E579 &data7B22token223A22d970cff43811438bba9050503510345b227D
3 API接口
31 户登录
311 功说明
该接口户登录通该接口获取户token该 token标识户续接口需户信息接口需该token作入参
312 接口定义
URL
v1sysuserlogin
请求方法
POST
请求参数
参数名称
否必须
类型
描述
code
必须
String
户帐号
pwd
必须
String
密码(MD5加密)
返回结果
参数名称
否必须
类型
描述
success
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
313 请求参数示例
{
code admin
pwd e00cf25ad42683b3df678c61f42c6bda
}
314 响应结果示例
{
success true
msg 登录成功
data e5b903f1667446c99e005acd27a1b12e
}
32 获取户信息
321 功说明
该接口户信息需户登录调
322 接口定义
URL
v1sysuserresetPwd
请求方法
POST
请求参数
参数名称
否必须
类型
描述
sp_sessionid
必须
String
token(cookie)
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
返回户信息
323 请求参数示例
{
sp_sessionid e5b903f1667446c99e005acd27a1b12e
}
cookie
324 响应结果示例
{
data {
uid e5b903f1667446c99e005acd27a1b12e
created 20180906 140327404
updated 20180906 141812822
user_id 397e287503994f90ba04177993418b3a
user_code admin
user_name 系统理员
role_id 658ae1db55ba42a7a8975cca7a79ee7b
user_type 9
}
msg 注销成功
success true
}
33 刷新户状态
331 功说明
该接口户信息更新隔90秒更新次
332 接口定义
URL
v1sysuserkeepAlive
请求方法
POST
请求参数
参数名称
否必须
类型
描述
sp_sessionid
必须
String
token(cookie)
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
333 请求参数示例
{
sp_sessionid e5b903f1667446c99e005acd27a1b12e
}
cookie
334 响应结果示例
{
data {
uid e5b903f1667446c99e005acd27a1b12e
created 20180906 140327404
updated 20180906 141812822
user_id 397e287503994f90ba04177993418b3a
user_code admin
user_name 系统理员
role_id 658ae1db55ba42a7a8975cca7a79ee7b
user_type 9
}
msg 注销成功
success true
}
34 修改密码
341 功说明
该接口户登录通该接口获取户token该 token标识户续接口需户信息接口需该token作入参
342 接口定义
URL
v1sysuserresetPwd
请求方法
POST
请求参数
参数名称
否必须
类型
描述
uid
必须
String
帐号
oldpwd
必须
String
旧密码
newpwd
必须
String
新密码
返回结果
参数名称
否必须
类型
描述
success
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
帐号
343 请求参数示例
{
newpwd 21232f297a57a5a743894a0e4a801fc3
oldpwd 21232f297a57a5a743894a0e4a801fc3
uid 397e287503994f90ba04177993418b3a
}
344 响应结果示例
{
data 397e287503994f90ba04177993418b3a
msg 重置密码成功
success true
}
35 获取停车场
351 功说明
该接口获取停车场信息需求户登录
352 接口定义
URL
v1infoparking
请求方法
GET
请求参数
参数名称
否必须
类型
描述
sp_sessionid
必须
Token(cookie)
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
353 请求参数示例
{
}
354 响应结果示例
{
success true
total 1
data [
{
code 1
created 20180728 174924337
name 测试车场
status 0
uid ebb745f1ab2b48ec9d9d54914fd5dd6b
updated 20180728 174924337
}
]
}
36 获取岗亭列表
361 功说明
该接口获取停车场信息需求户登录
362 接口定义
URL
v1infosentrytree
请求方法
GET
请求参数
参数名称
否必须
类型
描述
sp_sessionid
必须
Token(cookie)
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
363 请求参数示例
{
}
364 响应结果示例
{
data [
{
children [
{
code 1
name 1号岗亭
uid a370f62f30ae4742bc8954a22d73b419
}
{
code 2
name 2号岗亭
uid 954e660483524f529d1c2dbb0a09c461
}
]
code 1
name 测试车场
type parking
uid ebb745f1ab2b48ec9d9d54914fd5dd6b
}
{
children [
{
code
name 岗亭
uid de5eb1dc383440e8a7ac41e123ea4829
}
]
code 2
name 2号车库
type parking
uid 0d955fe07f1a442a99a28428904dc970
}
]
msg
success true
}
37 获取车道
371 功说明
该接口获取前岗亭车道信息需求户登录
372 接口定义
URL
v1infolanelist
请求方法
GET
请求参数
参数名称
否必须
类型
描述
sentry_id
必须
String
岗亭ID
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
factory
String
摄机厂家
1VZ
2HX
9RTSP
video_sort
String
视频窗口排序
name
String
车道名称
gate_mode
String
道闸类型(单闸双闸)
373 请求参数示例
{
sentry_id168bf849b8a24de5bc5792de75a97f60
}
374 响应结果示例
{
data [
{
code
created 20180906 152748887
extended
factory 2
gate_mode 0
ip 1921685172
name 出口
parent_id 168bf849b8a24de5bc5792de75a97f60
park_id ebb745f1ab2b48ec9d9d54914fd5dd6b
pass_word 123456
port 9001
power 11111
sn 16030000a1ba
status 0
type 0
uid 0c3992bbbd1649cab622bf852106664d
updated 20180906 152748887
user_name admin
video_sort 0
}
{
code
created 20180906 152749016
extended
factory 1
ip 1921681173
name 入口
parent_id 168bf849b8a24de5bc5792de75a97f60
park_id ebb745f1ab2b48ec9d9d54914fd5dd6b
pass_word admin
port 9001
power 11111
sn 6e4073861c726fb1
status 0
type 0
uid 1646bbd537634fe0bf64601f2c677c33
updated 20180906 152749016
user_name admin
video_sort 0
}
]
msg
success true
}
38 计费接口
381 功说明
该接口计算停车费需求户登录停车优惠券暂时未考虑
382 接口定义
URL
v1infochargecharge
请求方法
GET
请求参数
参数名称
否必须
类型
描述
time_start
必须
String
开始时间
time_end
必须
String
结算时间
park_id
必须
String
停车场ID
model
必须
String
车型
plate_no
必须
String
车牌号
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
fee
必须
float
费
minuteString
必须
String
停车时长
383 请求参数示例
time_start 20180906 120001
time_end 20180906 140001
park_id ebb745f1ab2b48ec9d9d54914fd5dd6b
model 1
plate_no 闽A23456
384 响应结果示例
{
data {
fee 6
items [
{
type 首段
money 5
time_start 20180906 1200
time_end 20180906 1300
remark 白天500元60分钟
}
{
type 二段
money 1
time_start 20180906 1300
time_end 20180906 1400
remark 白天100元60分钟
}
]
items_total 2
minute 120
minuteString 2时0分
valid_minute 120
}
msg ok
success true
}
39 保存入场信息
391 功说明
该接口保存入场信息需求户登录
392 接口定义
URL
v1busirecordssavein
请求方法
GET
请求参数
参数名称
否必须
类型
描述
io_time
必须
String
入场时间
channel_id
必须
通道ID
plate_no
必须
车牌号码
color
必须
车牌颜色
card_no
必须
卡号
pic_big
必须
图片路径
pic_small
选
图片路径
reason
选
放行原编号
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
393 请求参数示例
{
io_time 20180906 120109
plate_no 粤SC8L28
channel_id 1646bbd537634fe0bf64601f2c677c33
color 1
card_no
pic_big 201809201809066e4073861c726fb111203jpg
pic_small
reason01
}
394 响应结果示例
{
msg 保存成功
success true
}
310 获取场车辆
3101 功说明
该接口获取场车辆信息需求户登录
3102 接口定义
URL
v1busirecordsentry
请求方法
GET
请求参数
参数名称
否必须
类型
描述
time_start
选
String
开始时间
time_end
选
String
结束时间
plate_no
选
String
车牌号码
tolerant
选
String
容错字符数(190275 450 625)
返回结果
参数名称
否必须
类型
描述
success
必须
Bool
成功状态
msg
必须
String
失败原描
data
plate_no
车号
io_time
入场时间
uid
入场ID
car_model
车型
card_type
车辆类
pic_big
图
pic_small
图
3103 请求参数示例
{
}
3104 响应结果示例
{
success true
total 1
data [
{
car_model 1
card_type 0
channel_id 1646bbd537634fe0bf64601f2c677c33
color
io_time 20180910 163913
pic_big pics2018091076933jpg
pic_small pics20180910small76933jpg
plate_no 闽A23456
uid 68c8f64f6cd643be8f243d9fd1e60b6a
}
]
}
311 保存出场信息
3111 功说明
该接口时保存出场支付订单需求户登录
3112 接口定义
URL
v1busirecordssaveout
请求方法
GET
请求参数
参数名称
否必须
类型
描述
io_time
必须
String
入场时间
channel_id
必须
String
通道ID
plate_no
必须
String
车牌号码
color
必须
String
车牌颜色
card_no
必须
String
卡号
pic_big
必须
String
图片路径
pic_small
选
String
图片路径
reason
选
String
放行原编号
ref_id
必须
String
入场ID
fee
必须
float
应收金额(停车费)
fee_discount
必须
float
优惠金额
fee_ real
必须
float
实收金额
pay_mode
必须
int
支付方式:0:现金
pay_channel
必须
int
支付渠道0 岗亭
pass_type
必须
int
放行方式:0:识放行
payee_code
必须
String
收款帐号
uid
选填
String
出场ID
返回结果
参数名称
否必须
类型
描述
success
必须
Bool
成功状态
msg
必须
String
失败原描
3113 请求参数示例
{
}
3114 响应结果示例
{
msg 保存成功
success true
}
312 保存支付订单
3121 功说明
暂时未实现保存出场已实现
3122 接口定义
URL
v1busipayordersave
请求方法
GET
请求参数
参数名称
否必须
类型
描述
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
3123 请求参数示例
{
sentry_id168bf849b8a24de5bc5792de75a97f60
}
3124 响应结果示例
313 传图片
3131 功说明
该接口传图片服务器
3132 接口定义
URL
v1busirecordspicsavemdlane filename (图)
v1busirecordspicsavemdlanesmallfilename (图)
v1busirecordspicsavemdlanesnapfilename 抓拍图
请求方法
POST
请求参数
参数名称
否必须
类型
描述
图片
必须
流文件
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
token
3133 请求参数示例
{
sentry_id168bf849b8a24de5bc5792de75a97f60
}
3134 响应结果示例
{
msg 保存成功
success true
}
314 获取参数
3141 功说明
该接口获取系统参数需求户登录
3142 接口定义
URL
v1sysconfall
请求方法
GET
请求参数
参数名称
否必须
类型
描述
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
code
参数编号
value
参数值
3143 请求参数示例
{
}
3144 响应结果示例
{
data [
{
attr
code P0101
extended
value 粤S
}
{
attr
code P0215
extended
value 1
}
]
success true
total 2
}
315 获取数字典
3151 功说明
该接口获取系统数字典数免登录
3152 接口定义
URL
v1sysdictlist
请求方法
GET
请求参数
参数名称
否必须
类型
描述
groupcode
必须
String
类编码
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
code
String
编码
value
String
名称
3153 请求参数示例
{
}
3154 响应结果示例
{
data [
{
code 1
extended
group_code S002
remarks
sort 1
status 0
uid 4b84945464f0498c9ed144ee1124da2b
value 型车
}
{
code 2
extended
group_code S002
remarks
sort 2
status 0
uid 52d90a6aa48f43f087ea13719f7273b8
value 型车
}
]
success true
total 0
}
316 抓拍记录
3161 功说明
该接口提交工开闸记录
3162 接口定义
URL
v1busisnap
请求方法
POST
请求参数
参数名称
否必须
类型
描述
io_time
必须
String
出入时间
direction
必须
Int
方:0:入 1:出
type
必须
Int
类型:0:电脑开闸 1遥控开闸
pic_big
必须
String
全景片路径
park_id
必须
String
停车场ID
channel_id
必须
String
通道
oper_code
必须
String
操作员
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
3163 请求参数示例
{
}
3164 响应结果示例
{
msg 保存成功
success true
}
317 班确认
3171 功说明
班时调该接口交班更新时间
3172 接口定义
URL
v1busiaccountwork
请求方法
GET
请求参数
参数名称
否必须
类型
描述
uses_id
必须
户编号
work_start
必须
班时间
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
work_start
String
班时间
3173 请求参数示例
{
}
3174 响应结果示例
{
}
318 获取结班信息
3181 功说明
该接口结班信息
3182 接口定义
URL
v1busiaccountinfo
请求方法
GET
请求参数
参数名称
否必须
类型
描述
uses_id
必须
户编号
work_start
必须
班时间
work_end
必须
结班时间(交班)
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
fee
float
应收金额
fee_discount
float
优惠金额
fee_real
float
实收金额
order_count
int
收费次数
free_count
int
免费次数
3183 请求参数示例
{
}
3184 响应结果示例
{
}
319 结班处理
3191 功说明
该接口结班处理
3192 接口定义
URL
v1busiaccountbalance
请求方法
POST
请求参数
参数名称
否必须
类型
描述
uses_id
必须
户ID
work_start
必须
班时间
work_end
必须
结班时间(交班)
返回结果
参数名称
否必须
类型
描述
successs
必须
Bool
成功状态
msg
必须
String
失败原描
data
String
3193 请求参数示例
{
}
3194 响应结果示例
{
msg 保存成功
success true
}
4 MQ接口
41 通行数实时传
411 功说明
412 接口定义
Tops
parkclientapp[SN]message
请求参数
参数名称
否必须
类型
描述
uid
必须
String
记录ID
plateno
必须
String
车牌号
color
必须
String
颜色
card_type
必须
String
车辆类(时车)
car_model
选
String
车型
is_specialplate
选
String
否特殊车牌
io_time
必须
String
通行时间
in_time
选
String
入场时间
park_id
必须
String
停车场id
channel_id
必须
String
通道id
card_no
选
String
卡号
pass
必须
Int
通行方式
type
必须
Int
进出类型:0入1出
topic
必须
String
题
command
必须
String
命令号
pic_big
选
String
图
pic_samll
选
String
图
in_pic_url
选
String
入场图片址
in_channel_id
选
String
入场通道
in_id
选
String
入场ID
pic_url
选
String
前图片址
led
选
String
LED显示
sound
选
String
语音
fee
选
String
计费金额
sn
必须
String
SN
413 请求参数示例
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
该内容是文档的文本内容,更好的格式请下载文档