企信通機(jī)動(dòng)車合格證
API接口規(guī)范
一、概述
《企信通機(jī)動(dòng)車合格證API接口規(guī)范》(以下簡(jiǎn)稱本規(guī)范)是由湖北企信通科技有限公司(以下簡(jiǎn)稱本公司)研發(fā),并實(shí)現(xiàn)2024年現(xiàn)行機(jī)動(dòng)車合格證二維碼規(guī)范進(jìn)行解析的功能,解析并返回機(jī)動(dòng)車合格證二維碼中包括的合格證上的1-35項(xiàng)的信息。此功能僅限公司內(nèi)部管理使用,嚴(yán)禁用于非法用途;
二、 接口規(guī)范
本規(guī)范主要是企信通機(jī)動(dòng)車合格證平臺(tái)解碼通用接口規(guī)范。包括:通用接口中參數(shù)及返回值說(shuō)明等內(nèi)容。
2.1 協(xié)議格式
2.1.1 通信協(xié)議
● 請(qǐng)求參數(shù)與返回參數(shù)都以JSON 格式作為數(shù)據(jù)格式
● 字符集默認(rèn)使用 UTF-8,請(qǐng)勿使用其它字符集
● 所有業(yè)務(wù)接口默認(rèn)為post
2.1.2 數(shù)據(jù)約束
● 與日期,時(shí)間有關(guān)的信息以yyyy-MM-dd HH:mm:ss格式傳輸
● 業(yè)務(wù)接口非必填參數(shù)可不傳,若傳,則參數(shù)值不能為空
2.2 系統(tǒng)級(jí)參數(shù)約束
2.3.1 請(qǐng)求說(shuō)明
客戶端在請(qǐng)求時(shí),需要按照如下步驟生成簽名 Signature,并添加公共參數(shù)!
2.3.2 公共請(qǐng)求參數(shù)
在原始請(qǐng)求的基礎(chǔ)上添加 Header 請(qǐng)求參數(shù):
參數(shù)名稱 | 參數(shù)類型 | 必填 | 說(shuō)明 |
accessKey | string | Y | 身份標(biāo)識(shí)(企信通公司分配) |
timestamp | long | Y | 時(shí)間戳,精確到秒 |
nonce | int | Y | 唯一隨機(jī)數(shù),建議為一個(gè)6位的隨機(jī)數(shù) |
sign | string | Y | 簽名數(shù)據(jù)(見(jiàn)“計(jì)算簽名”部分) |
計(jì)算簽名
● 按照如下順序?qū)φ?qǐng)求中的參數(shù)進(jìn)行排序,各個(gè)參數(shù)通過(guò)&進(jìn)行拼接(中間不含空格):
method & url & accessKey & timestamp & nonce
■ method 需要大寫,如:GET
■ url 去除協(xié)議、域名、參數(shù),以 / 開頭,如:
/api/wtorg/vehicle_certificate
● 使用 HMAC-SHA256 協(xié)議創(chuàng)建基于哈希的消息身份驗(yàn)證代碼 (HMAC),以 appSecret 作為密鑰,對(duì)上面拼接的參數(shù)進(jìn)行計(jì)算簽名,所得簽名進(jìn)行 Base-64 編碼
HMAC-SHA256 在線計(jì)算:https://1024tools.com/hmac
2.3.3 返回說(shuō)明
返回結(jié)果采用 JSON 格式,包含code、message、result等字段
參數(shù)名稱 | 參數(shù)類型 | 必填 | 說(shuō)明 |
code | Integer | Y | 200 標(biāo)識(shí)成功,非200 失敗 |
type | string | Y | 返回類型,如成功:success |
message | string | 失敗時(shí),返回原因 | |
result | object | 返回?cái)?shù)據(jù),json 格式 | |
extras | object | 返回?cái)?shù)據(jù),json 格式 | |
time | datetime | 返回時(shí)間 |
三、平臺(tái)方提供的接口
接口地址:請(qǐng)聯(lián)系五通軟件公司獲取!
3.1 解碼機(jī)動(dòng)車合格證接口
Url路徑:vehicle_certificate
描述:用于將機(jī)動(dòng)車合格證二維碼值內(nèi)容解碼。
3.1.1 接口請(qǐng)求模型
參數(shù)代碼 | 參數(shù)類型參數(shù)類型 | 參數(shù)長(zhǎng)度 | 代碼標(biāo)識(shí)說(shuō)明 | 是否非空 | 說(shuō)明 |
QrCode | string | 4000 | Y | 機(jī)動(dòng)車合格證二維碼值 |
3.1.2 接口返回模型
序號(hào) | 列名 | 數(shù)據(jù)類型 | 長(zhǎng)度 | 允許空 | 列說(shuō)明 |
1 | WZHGZBH | string | (4000) | √ | 合格證編號(hào) |
2 | FZRQ | string | (400) | √ | 發(fā)證日期 |
3 | CLZZQYMC | string | (4000) | √ | 車輛生產(chǎn)單位企業(yè)名稱 |
4 | CLPP | string | (4000) | √ | 車輛品牌 |
5 | CLMC | string | (4000) | √ | 車輛名稱 |
6 | CLXH | string | (4000) | √ | 車輛型號(hào) |
7 | CLSBDH | string | (4000) | √ | 車輛識(shí)別代號(hào) |
8 | CSYS | string | (4000) | √ | 車輛顏色 |
9 | DPXH | string | (4000) | √ | 底盤型號(hào) |
10 | DPID | string | (4000) | √ | 底盤ID |
11 | DPHGZBH | string | (4000) | √ | 底盤合格證編號(hào) |
12 | FDJXH | string | (4000) | √ | 發(fā)動(dòng)機(jī)型號(hào) |
13 | FDJH | string | (4000) | √ | 發(fā)動(dòng)機(jī)號(hào) |
14 | RLZL | string | (4000) | √ | 燃料種類 |
15 | PL | string | (4000) | √ | 排量 |
16 | GL | string | (4000) | √ | 功率 |
17 | PFBZ | string | (4000) | √ | 排放標(biāo)準(zhǔn) |
18 | YH | string | (4000) | √ | 油耗 |
19 | WKC | string | (4000) | √ | 外廓長(zhǎng) |
20 | WKK | string | (4000) | √ | 外廓寬 |
21 | WKG | string | (4000) | √ | 外廓高 |
22 | HXNBC | string | (4000) | √ | 貨箱內(nèi)部長(zhǎng) |
23 | HXNBK | string | (4000) | √ | 貨箱內(nèi)部寬 |
24 | HXNBG | string | (4000) | √ | 貨箱內(nèi)部高 |
25 | GBTHPS | string | (4000) | √ | 鋼板彈簧片數(shù) |
26 | LTS | string | (4000) | √ | 輪胎數(shù) |
27 | LTGG | string | (4000) | √ | 輪胎規(guī)格 |
28 | QLJ | string | (4000) | √ | 前輪距 |
29 | HLJ | string | (4000) | √ | 后輪距 |
30 | ZJ | string | (4000) | √ | 軸距 |
31 | ZH | string | (4000) | √ | 軸荷 |
32 | ZS | string | (4000) | √ | 軸數(shù) |
33 | ZXXS | string | (4000) | √ | 轉(zhuǎn)身形式 |
34 | ZZL | string | (4000) | √ | 總質(zhì)量 |
35 | EDZZL | string | (4000) | √ | 額定載質(zhì)量 |
36 | ZBZL | string | (4000) | √ | 整備質(zhì)量 |
37 | ZZLLYXS | string | (4000) | √ | 載質(zhì)量利用系數(shù) |
38 | ZQYZZL | string | (4000) | √ | 準(zhǔn)索引總質(zhì)量 |
39 | BGCAZZDYXZZL | string | (4000) | √ | 半掛車鞍座最大允許總質(zhì)量 |
40 | JSSZCRS | string | (4000) | √ | 駕駛室準(zhǔn)乘人數(shù) |
41 | EDZK | string | (4000) | √ | 額定載客 |
42 | ZGCS | string | (4000) | √ | 最高設(shè)計(jì)車速 |
43 | CLZZRQ | string | (400) | √ | 車輛制造日期 |
以上返回?cái)?shù)據(jù)參考按2024現(xiàn)行機(jī)動(dòng)車合格證文件的1-35項(xiàng)記錄,如下圖所示:
Demo:
Request:
{ "qrCode": "ZCCCHGZ_V3.1 141030#1184|C206A0012319…………"}
Response(部分信息涉密,已被隱藏,測(cè)試賬號(hào)使用時(shí),會(huì)有部分內(nèi)容被隱藏!):
{ "code": 200, "type": "success", "message": "", "result": { "cph": "ASVXF7…………", "pc": "368", "ggsxrq": "2023-03-10", "wzhgzbh": "YE8085000…………", "fzrq": "2023年09月28日", "clzzqymc": "廣汽豐田汽車有限公司", "cllx": "乘用車及客車", "clmc": "混合動(dòng)力多用途乘用車", "clpp": "豐田牌/TOYOTA", "clxh": "GTM65…………", "csys": "白", "clsbdh": "LVGDD4A…………50", "cjh": "", "fdjh": "LG2……", "fdjxh": "A25D", "rlzl": "混合動(dòng)力", "pfbz": "GB18352.6-2016 國(guó)Ⅵ", "pl": "2487", "gl": "139", "zxxs": "方向盤", "qlj": "1725", "hlj": "1726", "lts": "4", "ltgg": "235/60R18", "zj": "3060", "zh": "1210/1590", …………………… "wkc": "5165", "wkk": "1995", "wkg": "1765", "zgcs": "180", "clzzrq": "2023年09月27日", "bz": "輪輞,迎賓燈;發(fā)動(dòng)機(jī)凈功率值:139kW.", "qybz": "Q/GQFT 263-2023《豐田(TOYOTA)牌GTM6521SHEVR型混合動(dòng)力多用途乘用車企業(yè)產(chǎn)品標(biāo)準(zhǔn)》", "cpscdz": "廣州市南沙區(qū)黃閣鎮(zhèn)市南大道8號(hào)", "qyqtxx": "5.77", "clscdwmc": "廣汽豐田汽車有限公司", "yh": "5.77", "pzxlh": "440101910……0007", "qrCode": "ZCCCHGZ_V3.1 141030#1184|C206A00123194……", }, "extras": null, "time": "2023-12-05 00:03:47"}
四、其他說(shuō)明
4.1、此接口規(guī)范及使用,僅限公司內(nèi)部管理使用,嚴(yán)禁用于非法用途;
4.2、僅針對(duì)接口調(diào)用方提交的數(shù)據(jù)進(jìn)行解析服務(wù),并返回接口文件檔中的數(shù)據(jù)字段;返回解析結(jié)果由接口調(diào)用方自行處理,與企信通軟件無(wú)關(guān)且企信通軟件不承擔(dān)任何責(zé)任;
4.3、企信通軟件不存儲(chǔ)接口調(diào)用方提交的數(shù)據(jù)的解析結(jié)果;
4.4、通常情況下,接口服務(wù)器在接收到請(qǐng)求數(shù)據(jù)后,返回解析結(jié)果的響應(yīng)時(shí)間會(huì)在1S左右。實(shí)際使用時(shí)響應(yīng)時(shí)間不排除雙方網(wǎng)絡(luò)波動(dòng)或其它因素等造成的網(wǎng)絡(luò)延遲或解析延遲的情況;
更多功能定制需求,請(qǐng)與五通軟件公司聯(lián)系!