[关闭]
@zushuxin 2024-03-12T09:13:43.000000Z 字数 10813 阅读 43


北京停简单信息技术有限公司

智舱停车业务停简单开发平台接口文档

内部文档,版权所有,请勿传播,违者必究

1. 约定

  1. 本文档为业务接口文档,完整请求需结合开放平台接入文档一起使用。
  2. 接口如无特殊说明,遵照以下规范:
  3. 金额格式统一为:(最大9位).(最多2位)。需要通过此正则表达式^((([1-9]{1}\\d{0,9}))|([0]{1}))((\\.(\\d){2}))?$
  4. isSuccess 返回结果说明:0=成功,1=业务失败,2=系统失败,其他标识=自定义失败。
  5. 本业务接口中,时间格式默认为:YYYYMMDDHHMISS
  6. 车牌颜色仅识别:blue|yellow|green|white|black
  7. 车牌号规则:6-9
  8. 考虑到接口扩展情况,停简单提供的接口可能会扩展返回值,但是不会删除key和修改返回值类型,即会保证向下兼容,请调用方给予兼容操作。
  9. 接入方提供接口中,若停简单推送数据有向下兼容的变更(新增推送数据),也请给予兼容。

2. 停简单提供接口

2.1 车辆服务

2.1.1 注册车牌

参数 类型 是否必须 名称 备注
carNum string Y 车牌号 长度为6~9位
carNumColor string N 车牌颜色 默认值:blue,可选值:blue|yellow|green|white|black
phone string N 用户手机号 长度最大15位
outCarId string N 接入方系统对应车牌ID 长度最大32位,在接入方系统唯一,如填写此参数,进场通知会包含此参数值

* 请求参数示例:

  1. {
  2. "service": "parkhub.car.register",
  3. "partner": "120a565de377427184de35ca0f320764",
  4. "sign": "3347b109a1e44f3fd5baa78b74184948",
  5. "signType": "md5",
  6. "charset": "utf-8",
  7. "version": "1.0",
  8. "timestamp": "2016-05-26 11:30:10",
  9. "carNum": "京A12345",
  10. "carNumColor": "blue",
  11. "phone": "13600000000",
  12. "outCarId": "432d85d7441346d29504f480e6a734a8"
  13. }
参数 类型 名称 备注
timestamp string 响应时间
returnCode string 响应码
returnMsg string 响应描述
isSuccess string 请求是否成功
errorMSG string 错误信息
carId string 停简单车牌ID 长度为32位

* 响应参数示例:

  1. {
  2. "timestamp": "1464235239561",
  3. "returnCode": "T",
  4. "returnMsg": "OK",
  5. "isSuccess": "0",
  6. "errorMSG": "",
  7. "carId": "11ce3dca34124e97830ad466e532eda7"
  8. }

2.1.2 注销车牌

参数 类型 是否必须 名称 备注
carId string Y 停简单车牌ID

* 请求参数示例:

  1. {
  2. "service": "parkhub.car.writeOff",
  3. "partner": "120a565de377427184de35ca0f320764",
  4. "sign": "3347b109a1e44f3fd5baa78b74a84948",
  5. "signType": "md5",
  6. "charset": "utf-8",
  7. "version": "1.0",
  8. "timestamp": "2016-05-26 11:30:10",
  9. "carId":"d24e8eb144a047bc99aa292033b2de45"
  10. }
参数 类型 名称 备注
timestamp string 响应时间
returnCode string 响应码
returnMsg string 响应描述
isSuccess string 请求是否成功
errorMSG string 错误信息

* 响应参数示例:

  1. {
  2. "timestamp": "1464235239561",
  3. "returnCode": "T",
  4. "returnMsg": "OK",
  5. "isSuccess": "0",
  6. "errorMSG": ""
  7. }

2.2 停车场信息接口

2.2.1 根据地理位置查询停车场基本信息列表

参数 类型 长度 是否必须 名称 备注
longitude string Y 停车场经度 BD09坐标(百度坐标)
latitude string Y 停车场纬度 BD09坐标(百度坐标)
scope string Y 查询停车场的地理范围限制 单位:m,最大不超过3000,传递超过3000时使用3000

* 响应参数列表

参数 类型 长度 是否必须 名称 备注
timestamp string 响应时间
returnCode string 响应码
returnMsg string 响应描述
isSuccess string 请求是否成功 true 成功,false 失败
parkList array{object} 停车场列表
pmParkId string 停车场ID
parkName string 停车场名称
provinnce string 所在省份
city string 所在城市
district string 所在区县
parkType string 停车场类型 停车场车位类型(1、占道 2、路外开放 3、路外封闭 4、地下)
category string 停车场收费类型 0、免费 1、收费 2、限免
isOnlinePay string 是否支持在线支付 0是,1否
standardCount string 停车场备案车位数
maxCount string 停车场划线车位数
address string 地址
longitude string 停车场经度-BD09坐标(百度坐标)
latitude string 停车场纬度-BD09坐标(百度坐标)
wLongitude string 停车场经度-GCJ02坐标(火星坐标)
wLatitude string 停车场纬度-GCJ02坐标(火星坐标)
openTime string 停车场开放时间 格式hhmmss(070000)
closeTime string 停车场关闭时间 格式hhmmss(070000)
parktolls array{object} 停车场收费规则集合
carNumColor string 车牌号颜色 blue 蓝色,black 黑色,yellow 黄色
dayFeeStartTime string 白天收费开始时间
dayFeeEndTime string 白天收费结束时间
dayFirstTime string 日间首个收费区间时长 单位:分钟
dayFirstHour string 日间首个收费区间计费 单位:元
dayFirstMinTime string 日间首个收费区间内最小收费区间时长 单位:分钟
dayFirstMinAmount string 日间首个收费区间内最小收费区间计费 单位:元
dayOtherHour string 日间首个收费区间外计费 单位:元
dayOtherMinTime string 日间首个收费区间外最小收费区间时长 单位:分钟
dayOtherMinAmount string 日间首个收费区间外最小收费区间计费 单位:元
nightFeeStartTime string 夜间收费开始时间
nightFeeEndTime string 夜间收费结束时间
nightFirstTime string 夜间首个收费区间时长 单位:分钟
nightFirstHour string 夜间首个收费区间计费 单位:元
nightFirstMinTime string 夜间首个收费区间内最小收费区间时长 单位:分钟
nightFirstMinAmount string 夜间首个收费区间内最小收费区间计费 单位:元
nightOtherHour string 夜间首个收费区间外计费 单位:元
nightOtherMinTime string 夜间首个收费区间外最小收费区间时长 单位:分钟
nightOtherMinAmount string 夜间首个收费区间外最小收费区间计费 单位:元
maxAmount string 收费金额上限 单位:元
dayFreeTime string 日间免费停车时长 单位:分钟
dayIntervalFreeTime string 日间收费区间免费停车时长 单位:分钟
nightFreeTime string 夜间免费停车时长 单位:分钟
nightIntervalFreeTime string 夜间收费区间免费停车时长 单位:分钟

* 响应参数事例:

  1. {
  2. "timestamp": "2017-05-11 16:00:38 255",
  3. "returnCode": "T",
  4. "returnMsg": "OK",
  5. "isSuccess": "true",
  6. "parkList": [
  7. {
  8. "pmParkId": "f716ab908b4a4c5b955b16baae844a2c",
  9. "parkName": "青岛市中国海洋大学鱼山校区停车场",
  10. "category": "1",
  11. "isOnlinePay": "0",
  12. "maxCount": "2500",
  13. "standardCount": "2500",
  14. "provinnce": "山东省",
  15. "city": "青岛市",
  16. "district": "市南区",
  17. "address": "市南区鱼山路5号",
  18. "longitude": "120.341766",
  19. "latitude": "36.069068",
  20. "parkType": "3",
  21. "wLongitude": "120.335299",
  22. "wLatitude": "36.062971",
  23. "openTime": "070000",
  24. "closeTime": "235959",
  25. "parktolls": [
  26. {
  27. "carNumColor": "blue",
  28. "dayFeeStartTime": "070000",
  29. "dayFeeEndTime": "210000",
  30. "dayFirstTime": "60",
  31. "nightFirstTime": "60",
  32. "dayFirstHour": "4.0",
  33. "dayFirstMinTime": "30",
  34. "dayFirstMinAmount": "2.0",
  35. "dayOtherHour": "4.0",
  36. "dayOtherMinTime": "30",
  37. "dayOtherMinAmount": "2.0",
  38. "nightFeeStartTime": "210000",
  39. "nightFeeEndTime": "070000",
  40. "nightFirstHour": "4.0",
  41. "nightFirstMinTime": "30",
  42. "nightFirstMinAmount": "2.0",
  43. "nightOtherHour": "4.0",
  44. "nightOtherMinTime": "30",
  45. "nightOtherMinAmount": "2.0",
  46. "dayFreeTime": "0",
  47. "dayIntervalFreeTime": "0",
  48. "nightFreeTime": "0",
  49. "nightIntervalFreeTime": "0",
  50. "maxAmount": "0.0"
  51. }
  52. ]
  53. },
  54. {
  55. "pmParkId": "b57db46803364c7cab04722aaa448656",
  56. "parkName": "青岛市红岛路31号停车场",
  57. "category": "1",
  58. "isOnlinePay": "0",
  59. "maxCount": "100",
  60. "standardCount": "100",
  61. "provinnce": "山东省",
  62. "city": "青岛市",
  63. "district": "市南区",
  64. "address": "青岛市市南区红岛路31号",
  65. "longitude": "120.345178",
  66. "latitude": "36.073369",
  67. "parkType": "3",
  68. "wLongitude": "120.338733",
  69. "wLatitude": "36.067213",
  70. "openTime": "070000",
  71. "closeTime": "235959",
  72. "parktolls": [
  73. {
  74. "carNumColor": "blue",
  75. "dayFeeStartTime": "070000",
  76. "dayFeeEndTime": "210000",
  77. "dayFirstTime": "60",
  78. "nightFirstTime": "60",
  79. "dayFirstHour": "4.0",
  80. "dayFirstMinTime": "60",
  81. "dayFirstMinAmount": "4.0",
  82. "dayOtherHour": "4.0",
  83. "dayOtherMinTime": "60",
  84. "dayOtherMinAmount": "4.0",
  85. "nightFeeStartTime": "210000",
  86. "nightFeeEndTime": "070000",
  87. "nightFirstHour": "4.0",
  88. "nightFirstMinTime": "60",
  89. "nightFirstMinAmount": "4.0",
  90. "nightOtherHour": "4.0",
  91. "nightOtherMinTime": "60",
  92. "nightOtherMinAmount": "4.0",
  93. "dayFreeTime": "0",
  94. "dayIntervalFreeTime": "0",
  95. "nightFreeTime": "0",
  96. "nightIntervalFreeTime": "0",
  97. "maxAmount": "80.0"
  98. }
  99. ]
  100. }
  101. ]
  102. }

2.2.2 根据停车场id查询停车场相关信息

参数 类型 长度 是否必须 名称 备注
pmParkId string Y 停车场ID
参数 类型 长度 是否必须 名称 备注
timestamp string 响应时间
returnCode string 响应码
returnMsg string 响应描述
isSuccess string 请求是否成功 true 成功,false 失败
pmPark map{object} 停车场信息
pmParkId string 停车场ID
parkName string 停车场名称
provinnce string 所在省份
city string 所在城市
district string 所在区县
parkType string 停车场类型 停车场车位类型(1、占道 2、路外开放 3、路外封闭 4、地下)
category string 停车场收费类型 0、免费 1、收费 2、限免
isOnlinePay string 是否支持在线支付 0是,1否
standardCount string 停车场备案车位数
maxCount string 停车场划线车位数
address string 地址
longitude string 停车场经度-BD09坐标(百度坐标)
latitude string 停车场纬度-BD09坐标(百度坐标)
wLongitude string 停车场经度-GCJ02坐标(火星坐标)
wLatitude string 停车场纬度-GCJ02坐标(火星坐标)
openTime string 停车场开放时间 格式hhmmss(070000)
closeTime string 停车场关闭时间 格式hhmmss(070000)
parktolls array{object} 停车场收费规则集合
carNumColor string 车牌号颜色 blue 蓝色,black 黑色,yellow 黄色
dayFeeStartTime string 白天收费开始时间
dayFeeEndTime string 白天收费结束时间
dayFirstTime string 日间首个收费区间时长 单位:分钟
dayFirstHour string 日间首个收费区间计费 单位:元
dayFirstMinTime string 日间首个收费区间内最小收费区间时长 单位:分钟
dayFirstMinAmount string 日间首个收费区间内最小收费区间计费 单位:元
dayOtherHour string 日间首个收费区间外计费 单位:元
dayOtherMinTime string 日间首个收费区间外最小收费区间时长 单位:分钟
dayOtherMinAmount string 日间首个收费区间外最小收费区间计费 单位:元
nightFeeStartTime string 夜间收费开始时间
nightFeeEndTime string 夜间收费结束时间
nightFirstTime string 夜间首个收费区间时长 单位:分钟
nightFirstHour string 夜间首个收费区间计费 单位:元
nightFirstMinTime string 夜间首个收费区间内最小收费区间时长 单位:分钟
nightFirstMinAmount string 夜间首个收费区间内最小收费区间计费 单位:元
nightOtherHour string 夜间首个收费区间外计费 单位:元
nightOtherMinTime string 夜间首个收费区间外最小收费区间时长 单位:分钟
nightOtherMinAmount string 夜间首个收费区间外最小收费区间计费 单位:元
maxAmount string 收费金额上限 单位:元
dayFreeTime string 日间免费停车时长 单位:分钟
dayIntervalFreeTime string 日间收费区间免费停车时长 单位:分钟
nightFreeTime string 夜间免费停车时长 单位:分钟
nightIntervalFreeTime string 夜间收费区间免费停车时长 单位:分钟

* 响应参数事例:

  1. {
  2. "timestamp": "2017-05-11 16:00:38 255",
  3. "returnCode": "T",
  4. "returnMsg": "OK",
  5. "isSuccess": "true",
  6. "pmPark": {
  7. "pmParkId": "053b6f4dadda4ab7a859d6a085d2ccf1",
  8. "parkName": "青岛市市级机关新浦路停车场",
  9. "category": "1",
  10. "isOnlinePay": "0",
  11. "maxCount": "300",
  12. "standardCount": "260",
  13. "provinnce": "山东省",
  14. "city": "青岛市",
  15. "district": "市南区",
  16. "address": "青岛市市南区新浦路9号",
  17. "longitude": "120.391093",
  18. "latitude": "36.073982",
  19. "parkType": "3",
  20. "wLongitude": "120.384631",
  21. "wLatitude": "36.067883",
  22. "openTime": "070000",
  23. "closeTime": "235959",
  24. "parktolls": [
  25. {
  26. "carNumColor": "blue",
  27. "dayFeeStartTime": "070000",
  28. "dayFeeEndTime": "210000",
  29. "dayFirstTime": "60",
  30. "nightFirstTime": "60",
  31. "dayFirstHour": "4.0",
  32. "dayFirstMinTime": "60",
  33. "dayFirstMinAmount": "4.0",
  34. "dayOtherHour": "4.0",
  35. "dayOtherMinTime": "60",
  36. "dayOtherMinAmount": "4.0",
  37. "nightFeeStartTime": "210000",
  38. "nightFeeEndTime": "070000",
  39. "nightFirstHour": "4.0",
  40. "nightFirstMinTime": "60",
  41. "nightFirstMinAmount": "4.0",
  42. "nightOtherHour": "4.0",
  43. "nightOtherMinTime": "60",
  44. "nightOtherMinAmount": "4.0",
  45. "dayFreeTime": "0",
  46. "dayIntervalFreeTime": "0",
  47. "nightFreeTime": "0",
  48. "nightIntervalFreeTime": "0",
  49. "maxAmount": "20.0"
  50. }
  51. ]
  52. }
  53. }

3. 接入方系统提供接口

3.1 返回值说明

参数 类型 是否必须 名称 备注
isSuccess string Y 是否成功 参数值:0=请求成功,1=业务级失败(不进行重发),2=系统级失败(有重发机制)
errorMSG string N 错误描述

* 返回值参数示例:

  1. {
  2. "errorMSG": "",
  3. "isSuccess": "0"
  4. }

3.2 车流消息

3.2.1 进场通知

参数 类型 是否必须 名称 备注
parkId string Y 停车场ID
parkName string Y 停车场名称
carNum string Y 车牌号
carNumColor string Y 车牌颜色 参数值:blue|yellow|green|white|black
tradeId string Y 停车订单号
outCarId string N 接入方车牌ID 注册车牌时填写的接入方系统对应车牌ID
inDt string Y 进场时间 格式:yyyyMMddHHmmss
payUrl string Y 停简单收银台支付页面URL payUrl说明请参考在场订单查询接口
miniProgram string Y 小程序参数集 参数说明:
"miniProgram": "{
"path": "路径",
"extraData": { // 小程序请求所需参数
"prePayType": "预支付类型(请勿修改值)",
"channel": "操作渠道(请勿修改值)",
"isShowDetail": "是否展示详情页面,参见payUrl中isShowDetail使用说明",
"orderId": "停车订单号(请勿修改值)"
}
}
canFindCar string Y 是否支持查询车辆位置 参数值:0=支持,1=不支持
city string Y 城市
district string Y 区域
address string Y 停车场地址
lon string N 停车场位置经度 百度坐标系
lat string N 停车场位置纬度 百度坐标系
wLon string N 停车场位置经度 wgs84坐标系
wLat string N 停车场位置纬度 wgs84坐标系

* 请求参数示例:

  1. {
  2. "parkId": "77a3424e06e64248b4cf9e490c8c682d",
  3. "parkName": "测试停车场",
  4. "carNum": "京A12345",
  5. "carNumColor ": "blue",
  6. "tradeId": "6d697f7579724345881633a00ed3a671",
  7. "outCarId": "",
  8. "inDt": "20180516213810",
  9. "payUrl": "http://prep.tingjiandan.com/tcweixin/letter/prePay/pagePayInPark?prePayType=16&channel=30000&isShowDetail=true&orderId=6d697f7579724345881633a00ed3a671&returnUrl=",
  10. "miniProgram": "{
  11. \"path\": \"pages/pre_pay/index/main\",
  12. \"extraData\": {
  13. \"prePayType\": \"16\",
  14. \"channel\": \"30000\",
  15. \"isShowDetail\": \"true\",
  16. \"orderId\": \"6d697f7579724345881633a00ed3a671\"
  17. }
  18. }",
  19. "canFindCar": "0",
  20. "city": "北京市",
  21. "district": "海淀区",
  22. "address": "五道口",
  23. "lon": "74.000272",
  24. "lat": "159.768703",
  25. "wLon": "123.523032",
  26. "wLat": "35.430735"
  27. }

3.2.2 离场通知

参数 类型 是否必须 名称 备注
parkId string Y 停车场ID
parkName string Y 停车场名称
carNum string Y 车牌号
carNumColor string Y 车牌颜色 参数值:blue|yellow|green|white|black
tradeId string Y 停车订单号
inDt string Y 进场时间 格式:yyyyMMddHHmmss
outDt string Y 出场时间 格式:yyyyMMddHHmmss
parkAmount string Y 停车费金额 单位(元),保留小数点后两位
lon string N 停车场位置经度 百度坐标系
lat string N 停车场位置纬度 百度坐标系
wLon string N 停车场位置经度 wgs84坐标系
wLat string N 停车场位置纬度 wgs84坐标系

* 请求参数示例:

  1. {
  2. "parkId": "77a3424e06e64248b4cf9e490c8c682d",
  3. "parkName": "测试停车场",
  4. "carNum": "京A12345",
  5. "carNumColor ": "blue",
  6. "tradeId": "6d697f7579724345881633a00ed3a671",
  7. "inDt": "20180516213810",
  8. "outDt": "20180516230521",
  9. "parkAmount": "5.00",
  10. "lon": "74.000272",
  11. "lat": "159.768703",
  12. "wLon": "123.523032",
  13. "wLat": "35.430735"
  14. }
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注