當前位置:首頁 > 演講稿 > 正文
 

[新停車場API接口V1.1]V接口

發布時間:2019-09-29 09:32:13 影響了:

停車場API接口 目錄 目錄 1. 目的和用途 5 2. 通信協議 5 3. API接口 5 3.1. 用戶登錄 5 3.1.1. 功能說明 5 3.1.2. 接口定義 5 3.1.3. 請求參數示例 6 3.1.4. 響應結果示例 6 3.2. 獲取用戶信息 6 3.2.1. 功能說明 6 3.2.2. 接口定義 6 3.2.3. 請求參數示例 7 3.2.4. 響應結果示例 7 3.3. 刷新用戶狀態 7 3.3.1. 功能說明 7 3.3.2. 接口定義 8 3.3.3. 請求參數示例 8 3.3.4. 響應結果示例 8 3.4. 修改密碼 9 3.4.1. 功能說明 9 3.4.2. 接口定義 9 3.4.3. 請求參數示例 9 3.4.4. 響應結果示例 9 3.5. 獲取停車場 10 3.5.1. 功能說明 10 3.5.2. 接口定義 10 3.5.3. 請求參數示例 10 3.5.4. 響應結果示例 11 3.6. 獲取崗亭列表 11 3.6.1. 功能說明 11 3.6.2. 接口定義 11 3.6.3. 請求參數示例 12 3.6.4. 響應結果示例 12 3.7. 獲取車道 13 3.7.1. 功能說明 13 3.7.2. 接口定義 13 3.7.3. 請求參數示例 14 3.7.4. 響應結果示例 14 3.8. 計費接口 15 3.8.1. 功能說明 15 3.8.2. 接口定義 15 3.8.3. 請求參數示例 16 3.8.4. 響應結果示例 16 3.9. 保存入場信息 17 3.9.1. 功能說明 17 3.9.2. 接口定義 17 3.9.3. 請求參數示例 17 3.9.4. 響應結果示例 18 3.10. 獲取在場車輛 18 3.10.1. 功能說明 18 3.10.2. 接口定義 18 3.10.3. 請求參數示例 19 3.10.4. 響應結果示例 19 3.11. 保存出場信息 20 3.11.1. 功能說明 20 3.11.2. 接口定義 20 3.11.3. 請求參數示例 21 3.11.4. 響應結果示例 21 3.12. 保存支付訂單 21 3.12.1. 功能說明 21 3.12.2. 接口定義 21 3.12.3. 請求參數示例 22 3.12.4. 響應結果示例 22 3.13. 上傳圖片 22 3.13.1. 功能說明 22 3.13.2. 接口定義 22 3.13.3. 請求參數示例 22 3.13.4. 響應結果示例 23 3.14. 獲取參數 23 3.14.1. 功能說明 23 3.14.2. 接口定義 23 3.14.3. 請求參數示例 23 3.14.4. 響應結果示例 24 3.15. 獲取數據字典 24 3.15.1. 功能說明 24 3.15.2. 接口定義 24 3.15.3. 請求參數示例 25 3.15.4. 響應結果示例 25 4. MQ接口 26 4.1. 通行數據實時上傳 26 4.1.1. 功能說明 26 4.1.2. 接口定義 26 4.1.3. 請求參數示例 27 1. 目的和用途 2. 通信協議 接口采用 HTTP 協議,支持 GET 或 POST 請求方式(具體接口參見接口定義), 請求頭需要包含編碼描述:
Content-Type:application/x-www-form-urlencoded;charset=utf-8, POST 請求時內容示例如下: -----header----- POST 接口地址 HTTP/1.1 Content-Type:application/x-www-form-urlencoded;charset=utf-8 -----body------- merchant_no=9827c6b5c6d94485b912b6e90c92a7ae&time_stamp=20170328172011&sign=A3DE1813F4DDBADFC18555E18A2E579 &data=%7B%22token%22%3A%22d970cff4-3811-438b-ba90-50503510345b%22%7D 3. API接口 3.1. 用戶登錄 3.1.1. 功能說明 該接口用于用戶登錄使用,通過該接口獲取到用戶token。該 token用于標識用戶,后續接口需要用戶信息的接口需將該token作為入參使用。

3.1.2. 接口定義 URL /v1/sys/user/login 請求方法 POST 請求參數 參數名稱 是否必須 類型 描述 code 必須 String 用戶帳號 pwd 必須 String 密碼(MD5加密) 返回結果 參數名稱 是否必須 類型 描述 success 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String token 3.1.3. 請求參數示例 { "code": "admin" "pwd": "e00cf25ad42683b3df678c61f42c6bda" } 3.1.4. 響應結果示例 { "success": true, "msg": "登錄成功", "?data": "e5b903f1-6674-46c9-9e00-5acd27a1b12e" } 3.2. 獲取用戶信息 3.2.1. 功能說明 該接口用于用戶信息,需要用戶登錄調用。

3.2.2. 接口定義 URL /v1/sys/user/resetPwd 請求方法 POST 請求參數 參數名稱 是否必須 類型 描述 sp_sessionid 必須 String token(cookie) 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String 返回用戶信息 3.2.3. 請求參數示例 { "sp_sessionid": "e5b903f1-6674-46c9-9e00-5acd27a1b12e" } cookie 3.2.4. 響應結果示例 { "data": { "uid": "e5b903f1-6674-46c9-9e00-5acd27a1b12e", "created": "2018-09-06 14:03:27.404", "updated": "2018-09-06 14:18:12.822", "user_id": "397e2875-0399-4f90-ba04-177993418b3a", "user_code": "admin", "user_name": "系統管理員", "role_id": "658ae1db-55ba-42a7-a897-5cca7a79ee7b", "user_type": "9" }, "msg": "注銷成功", "success": true } 3.3. 刷新用戶狀態 3.3.1. 功能說明 該接口用于用戶信息更新,每隔90秒更新一次。

3.3.2. 接口定義 URL /v1/sys/user/keepAlive 請求方法 POST 請求參數 參數名稱 是否必須 類型 描述 sp_sessionid 必須 String token(cookie) 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 3.3.3. 請求參數示例 { "sp_sessionid": "e5b903f1-6674-46c9-9e00-5acd27a1b12e" } cookie 3.3.4. 響應結果示例 { "data": { "uid": "e5b903f1-6674-46c9-9e00-5acd27a1b12e", "created": "2018-09-06 14:03:27.404", "updated": "2018-09-06 14:18:12.822", "user_id": "397e2875-0399-4f90-ba04-177993418b3a", "user_code": "admin", "user_name": "系統管理員", "role_id": "658ae1db-55ba-42a7-a897-5cca7a79ee7b", "user_type": "9" }, "msg": "注銷成功", "success": true } 3.4. 修改密碼 3.4.1. 功能說明 該接口用于用戶登錄使用,通過該接口獲取到用戶token。該 token用于標識用戶,后續接口需要用戶信息的接口需將該token作為入參使用。

3.4.2. 接口定義 URL /v1/sys/user/resetPwd 請求方法 POST 請求參數 參數名稱 是否必須 類型 描述 uid 必須 String 帳號 oldpwd 必須 String 舊密碼 newpwd 必須 String 新密碼 返回結果 參數名稱 是否必須 類型 描述 success 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String 帳號 3.4.3. 請求參數示例 { "newpwd": "21232f297a57a5a743894a0e4a801fc3", "oldpwd": "21232f297a57a5a743894a0e4a801fc3", "uid": "397e2875-0399-4f90-ba04-177993418b3a" } 3.4.4. 響應結果示例 { "data": "397e2875-0399-4f90-ba04-177993418b3a", "msg": "重置密碼成功", "success": true } 3.5. 獲取停車場 3.5.1. 功能說明 該接口獲取所有停車場信息,需要求用戶登錄后使用。

3.5.2. 接口定義 URL /v1/info/parking 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 sp_sessionid 必須 Token(cookie) 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String token 3.5.3. 請求參數示例 { } 3.5.4. 響應結果示例 { "success": true, "total": 1, "data": [ { "code": "1", "created": "2018-07-28 17:49:24.337", "name": "測試車場", "status": "0", "uid": "ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b", "updated": "2018-07-28 17:49:24.337" } ] } 3.6. 獲取崗亭列表 3.6.1. 功能說明 該接口獲取所有停車場信息,需要求用戶登錄后使用。

3.6.2. 接口定義 URL /v1/info/sentry/tree 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 sp_sessionid 必須 Token(cookie) 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String token 3.6.3. 請求參數示例 { } 3.6.4. 響應結果示例 { "data": [ { "children": [ { "code": "1", "name": "1號崗亭", "uid": "a370f62f-30ae-4742-bc89-54a22d73b419" }, { "code": "2", "name": "2號崗亭", "uid": "954e6604-8352-4f52-9d1c-2dbb0a09c461" } ], "code": "1", "name": "測試車場", "type": "parking", "uid": "ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b" }, { "children": [ { "code": "", "name": "崗亭", "uid": "de5eb1dc-3834-40e8-a7ac-41e123ea4829" } ], "code": "2", "name": "2號車庫", "type": "parking", "uid": "0d955fe0-7f1a-442a-99a2-8428904dc970" } ], "msg": "", "success": true } 3.7. 獲取車道 3.7.1. 功能說明 該接口獲取當前崗亭的所有車道信息,需要求用戶登錄后使用。

3.7.2. 接口定義 URL /v1/info/lane/list 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 sentry_id 必須 String 崗亭ID 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String token factory String 攝像機廠家 1:VZ 2:HX 9:RTSP video_sort String 視頻窗口排序 name String 車道名稱 gate_mode String 道閘類型(單閘,雙閘) 3.7.3. 請求參數示例 { "sentry_id":"168bf849-b8a2-4de5-bc57-92de75a97f60" } 3.7.4. 響應結果示例 { "data": [ { "code": "", "created": "2018-09-06 15:27:48.887", "extended": "", "factory": "2", "gate_mode": "0", "ip": "192.168.5.172", "name": "出口", "parent_id": "168bf849-b8a2-4de5-bc57-92de75a97f60", "park_id": "ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b", "pass_word": "123456", "port": "9001", "power": "11111", "sn": "16030000a1ba", "status": "0", "type": "0", "uid": "0c3992bb-bd16-49ca-b622-bf852106664d", "updated": "2018-09-06 15:27:48.887", "user_name": "admin", "video_sort": "0" }, { "code": "", "created": "2018-09-06 15:27:49.016", "extended": "", "factory": "1", "ip": "192.168.1.173", "name": "入口", "parent_id": "168bf849-b8a2-4de5-bc57-92de75a97f60", "park_id": "ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b", "pass_word": "admin", "port": "9001", "power": "11111", "sn": "6e4073861c726fb1", "status": "0", "type": "0", "uid": "1646bbd5-3763-4fe0-bf64-601f2c677c33", "updated": "2018-09-06 15:27:49.016", "user_name": "admin", "video_sort": "0" } ], "msg": "", "success": true } 3.8. 計費接口 3.8.1. 功能說明 該接口計算停車的費用,需要求用戶登錄后使用。停車優惠券暫時未考慮 3.8.2. 接口定義 URL /v1/info/charge/charge 請求方法 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 停車時長 3.8.3. 請求參數示例 "time_start": "2018-09-06 12:00:01", "time_end": "2018-09-06 14:00:01", "park_id": "ebb745f1-ab2b-48ec-9d9d-54914fd5dd6b", "model": "1", "plate_no": "閩A23456" 3.8.4. 響應結果示例 { "data": { "fee": 6, "items": [ { "type": "首段", "money": 5, "time_start": "2018-09-06 12:00", "time_end": "2018-09-06 13:00", "remark": "白天5.00元/60分鐘" }, { "type": "二段", "money": 1, "time_start": "2018-09-06 13:00", "time_end": "2018-09-06 14:00", "remark": "白天1.00元/60分鐘" } ], "items_total": 2, "minute": 120, "minuteString": "2時0分", "valid_minute": 120 }, "msg": "ok", "success": true } 3.9. 保存入場信息 3.9.1. 功能說明 該接口保存入場信息,需要求用戶登錄后使用。

3.9.2. 接口定義 URL /v1/busi/records/save/in 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 io_time 必須 String 入場時間 channel_id 必須 通道ID plate_no 必須 車牌號碼 color 必須 車牌顏色 card_no 必須 卡號 pic_big 必須 大圖片路徑 pic_small 可選 小圖片路徑 reason 可選 放行原因編號 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 3.9.3. 請求參數示例 { "io_time": "2018-09-06 12:01:09", "plate_no": "粵SC8L28", "channel_id": "1646bbd5-3763-4fe0-bf64-601f2c677c33", "color": "1", "card_no": "", "pic_big": "/2018-09/2018-09-06/6e4073861c726fb1/11203.jpg", "pic_small": "", "reason":"01" } 3.9.4. 響應結果示例 { "msg": "保存成功", "success": true } 3.10. 獲取在場車輛 3.10.1. 功能說明 該接口獲取在場的車輛信息,需要求用戶登錄后使用。

3.10.2. 接口定義 URL /v1/busi/records/entry 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 time_start 可選 String 開始時間 time_end 可選 String 結束時間 plate_no 可選 String 車牌號碼 tolerant 可選 String 容錯字符數(1:90%、2:75% 、4:50% 6:25%) 返回結果 參數名稱 是否必須 類型 描述 success 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data plate_no 車號 io_time 入場時間 uid 入場ID car_model 車型 card_type 車輛類別 pic_big 大圖 pic_small 小圖 3.10.3. 請求參數示例 { } 3.10.4. 響應結果示例 { "success": true, "total": 1, "data": [ { "car_model": "1", "card_type": "0", "channel_id": "1646bbd5-3763-4fe0-bf64-601f2c677c33", "color": "", "io_time": "2018-09-10 16:39:13", "pic_big": "/pics/20180910/76933.jpg", "pic_small": "/pics/20180910/small/76933.jpg", "plate_no": "閩A23456", "uid": "68c8f64f-6cd6-43be-8f24-3d9fd1e60b6a" } ] } 3.11. 保存出場信息 3.11.1. 功能說明 該接口同時保存出場和支付訂單,需要求用戶登錄后使用。

3.11.2. 接口定義 URL /v1/busi/records/save/out 請求方法 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 失敗原因描 3.11.3. 請求參數示例 { } 3.11.4. 響應結果示例 { "msg": "保存成功", "success": true } 3.12. 保存支付訂單 3.12.1. 功能說明 暫時未實現,在保存出場已有實現了。

3.12.2. 接口定義 URL /v1/busi/payorder/save 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String token 3.12.3. 請求參數示例 { "sentry_id":"168bf849-b8a2-4de5-bc57-92de75a97f60" } 3.12.4. 響應結果示例 3.13. 上傳圖片 3.13.1. 功能說明 該接口上傳圖片到服務器。

3.13.2. 接口定義 URL /v1/busi/records/pic/save/:m/:d/:lane /:filename --(大圖) /v1/busi/records/pic/save/:m/:d/:lane/small/:filename --(小圖) /v1/busi/records/pic/save/:m/:d/:lane/snap/:filename --抓拍圖 請求方法 POST 請求參數 參數名稱 是否必須 類型 描述 圖片 必須 流文件 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String token 3.13.3. 請求參數示例 { "sentry_id":"168bf849-b8a2-4de5-bc57-92de75a97f60" } 3.13.4. 響應結果示例 { "msg": "保存成功", "success": true } 3.14. 獲取參數 3.14.1. 功能說明 該接口獲取系統參數,需要求用戶登錄后使用。

3.14.2. 接口定義 URL /v1/sys/conf/all 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String code 參數編號 value 參數值 3.14.3. 請求參數示例 { } 3.14.4. 響應結果示例 { "data": [ { "attr": "", "code": "P0101", "extended": "", "value": "粵S" }, { "attr": "", "code": "P0215", "extended": "", "value": "1" } ], "success": true, "total": 2 } 3.15. 獲取數據字典 3.15.1. 功能說明 該接口獲取系統數據字典數據,免登錄。

3.15.2. 接口定義 URL /v1/sys/dict/list 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 groupcode 必須 String 類別編碼 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String code String 編碼 value String 名稱 3.15.3. 請求參數示例 { } 3.15.4. 響應結果示例 { "data": [ { "code": "1", "extended": "", "group_code": "S002", "remarks": "", "sort": "1", "status": "0", "uid": "4b849454-64f0-498c-9ed1-44ee1124da2b", "value": "小型車" }, { "code": "2", "extended": "", "group_code": "S002", "remarks": "", "sort": "2", "status": "0", "uid": "52d90a6a-a48f-43f0-87ea-13719f7273b8", "value": "大型車" } ], "success": true, "total": 0 } 3.16. 抓拍記錄 3.16.1. 功能說明 該接口提交人工開閘記錄。

3.16.2. 接口定義 URL /v1/busi/snap 請求方法 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 3.16.3. 請求參數示例 { } 3.16.4. 響應結果示例 { "msg": "保存成功", "success": true } 3.17. 上班確認 3.17.1. 功能說明 上班時調用該接口,交班后更新時間。

3.17.2. 接口定義 URL /v1/busi/account/work 請求方法 GET 請求參數 參數名稱 是否必須 類型 描述 uses_id 必須 用戶編號 work_start 必須 上班時間 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String work_start String 上班時間 3.17.3. 請求參數示例 { } 3.17.4. 響應結果示例 { } 3.18. 獲取結班信息 3.18.1. 功能說明 該接口結班信息。

3.18.2. 接口定義 URL /v1/busi/account/info 請求方法 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 免費次數 3.18.3. 請求參數示例 { } 3.18.4. 響應結果示例 { } 3.19. 結班處理 3.19.1. 功能說明 該接口結班處理。

3.19.2. 接口定義 URL /v1/busi/account/balance 請求方法 POST 請求參數 參數名稱 是否必須 類型 描述 uses_id 必須 用戶ID work_start 必須 上班時間 work_end 必須 結班時間(交班) 返回結果 參數名稱 是否必須 類型 描述 successs 必須 Bool 成功狀態 msg 必須 String 失敗原因描 data String 3.19.3. 請求參數示例 { } 3.19.4. 響應結果示例 { "msg": "保存成功", "success": true } 4. MQ接口 4.1. 通行數據實時上傳 4.1.1. 功能說明 4.1.2. 接口定義 Tops /park/client/app/[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 4.1.3. 請求參數示例

相關熱詞搜索:停車場 接口 API V1

相關文章
最新文章

Copyright © 2008 - 2018 版權所有 101505資源網

工業和信息化部 湘ICP備14009742號-22

三张牌游戏炸金花