深圳市網(wǎng)絡(luò)預(yù)約出租汽車監(jiān)管系統(tǒng).doc

1、人證車證核驗接口協(xié)議1. 交換規(guī)則1.1. 設(shè)計原則為避免網(wǎng)約車監(jiān)管平臺與網(wǎng)約車公司平臺互為服務(wù)端進(jìn)行雙向通 信時帶來的部署方式局限，接口協(xié)議設(shè)計時盡量采用網(wǎng)約車監(jiān)管平臺 為服務(wù)端的模式。單一服務(wù)端的設(shè)計方式有利于接口服務(wù)的“微服務(wù)” 化，方便后期業(yè)務(wù)發(fā)展帶來的接口擴展。1.2. 協(xié)議標(biāo)準(zhǔn)內(nèi)網(wǎng)數(shù)據(jù)傳輸采用HTTP/HTTPS協(xié)議標(biāo)準(zhǔn)，互聯(lián)網(wǎng)數(shù)據(jù)傳輸采用 HTTPS基于HTTP POS方式進(jìn)行數(shù)據(jù)請求，編碼格式統(tǒng)一為UTF-8編 碼。協(xié)議對HTTP協(xié)議做適當(dāng)擴充，但不改變已有HTTP標(biāo)準(zhǔn)的任 何定義，實現(xiàn)者可以充分利用實現(xiàn)語言的 HTTP開發(fā)包。1.3. 傳輸協(xié)議說明Request:請求屬性名值

2、（示例）必填備注RequestHeadersbi nfile-md5請求文件二進(jìn)制流的MD5摘要，示例：bcf7837571fab538772f65b137b71b9dM文件md5摘要，用于數(shù)據(jù)元 整性校驗bin file-gzitrue 或者 flaseO響應(yīng)是否采用 GZIP壓縮Pbin file-aut hTICKETM單位標(biāo)識鑒權(quán)（格式：16位 英文字符串，不區(qū)分大小與）Content(FORMbi nFile傳輸文件的二進(jìn)制流M文件流multipart/form-data; boun dary=in putstreamfile nameZW_CZKKZCX_REQ_20150617,

3、O233.js on1 M文件名文件命名規(guī)范，詳見2.5Resp onse：請求header屬性值（示例）必填備注ResponseHeadersbi nfile-md5響應(yīng)文件二進(jìn)制流的MD5摘要，示例：bef7837571fab538772f65b137b71b9dM文件md5摘要，用于數(shù)據(jù)元 整性校驗Conten t-Disp ositi onattaehme nt;file name=ZW_CZKKZCX_RES_2015061710233.js on1 M與HTTP協(xié)議規(guī)定相冋，file name=返回的文件名文件命名規(guī)范，詳見 2.5Conten t-E neo dinggzipO與

4、HTTP協(xié)議規(guī)定相同Conten t-Le ngthCo nte nt-Le ngth:492M數(shù)據(jù)長度HTTP響應(yīng)狀態(tài)0 999M響應(yīng)碼，詳見2.4Content1. 請求成功時為返回文件的二進(jìn)制流。2. 當(dāng)狀態(tài)碼=700時返回錯誤信息字符串M文件流或者UTF-8編碼的字 符串14 響應(yīng)碼定義(Response Headers Status Code)響應(yīng)碼描述HTTP自定義返回碼（W 600）:200（成功） 服務(wù)器已成功處理了請求。201（已創(chuàng)建）請求成功并且服務(wù)器創(chuàng)建了新的資源。202（已接受）服務(wù)器已接受請求，但尚未處理。203（非授權(quán)信息）服務(wù)器已成功處理了請求，但返回的信息可能來

5、自另 一來源。204（無內(nèi)容） 服務(wù)器成功處理了請求，但沒有返回任何內(nèi)容。205（重置內(nèi)容）服務(wù)器成功處理了請求，但沒有返回任何內(nèi)容。206（部分內(nèi)容）服務(wù)器成功處理了部分 GET請求。300（多種選擇）針對請求，服務(wù)器可執(zhí)行多種操作。301（永久移動）請求的網(wǎng)頁已永久移動到新位置。302（臨時移動） 服務(wù)器目前從不冋位置的網(wǎng)頁響應(yīng)請求，但請求者應(yīng)繼續(xù)使用原有位置來進(jìn)行以后的請求。303（查看其他位置）請求者應(yīng)當(dāng)對不冋的位置使用單獨的GET請求來檢索響應(yīng)時，服務(wù)器返回此代碼。304（未修改） 自從上次請求后，請求的網(wǎng)頁未修改過。 服務(wù)器返回此響 應(yīng)時，不會返回網(wǎng)頁內(nèi)容。305（使用代理） 請求

6、者只能使用代理訪問請求的網(wǎng)頁。如果服務(wù)器返回此響應(yīng)，還表示請求者應(yīng)使用代理。307（臨時重疋向） 服務(wù)器目前從不冋位置的網(wǎng)頁響應(yīng)請求，但請求者應(yīng)繼續(xù)使用原有位置來進(jìn)行以后的請求。400（錯誤請求）服務(wù)器不理解請求的語法。401（未授權(quán)）請求要求身份驗證。403（禁止）服務(wù)器拒絕請求。404（未找到）服務(wù)器找不到請求的網(wǎng)頁。405（方法禁用） 禁用請求中指定的方法。406（不接受）無法使用請求的內(nèi)容特性響應(yīng)請求的網(wǎng)頁。407（需要代理授權(quán)）此狀態(tài)代碼與401 （未授權(quán)）類似，但指定請求者 應(yīng)當(dāng)授權(quán)使用代。408（請求超時）服務(wù)器等候請求時發(fā)生超時。409（沖突）服務(wù)器在完成請求時發(fā)生沖突。410

7、（已刪除） 如果請求的資源已永久刪除，服務(wù)器就會返回此響應(yīng)。411（需要有效長度）服務(wù)器不接受不含有效內(nèi)容長度標(biāo)頭字段的請求。412（未滿足前提條件）服務(wù)器未滿足請求者在請求中設(shè)置的其中一個前 提條件。413（請求實體過大） 服務(wù)器無法處理請求， 因為請求實體過大， 超出服 務(wù)器的處理能力。414（請求的URI過長）請求的URI （通常為網(wǎng)址）過長，服務(wù)器無法 處理。415（不支持的媒體類型）請求的格式不受請求頁面的支持。416（請求范圍不符合要求）如果頁面無法提供請求的范圍，則服務(wù)器會返回此狀態(tài)代碼。417（未滿足期望值）服務(wù)器未滿足”期望”請求標(biāo)頭字段的要求。500（服務(wù)器內(nèi)部錯誤）服務(wù)器

8、遇到錯誤，無法完成請求。501（尚未實施）服務(wù)器不具備完成請求的功能。502（錯誤網(wǎng)關(guān)）服務(wù)器作為網(wǎng)關(guān)或代理，從上游服務(wù)器收到無效響應(yīng)。503（服務(wù)不可用）服務(wù)器目前無法使用（由于超載或停機維護(hù)）。504（網(wǎng)關(guān)超時） 服務(wù)器作為網(wǎng)關(guān)或代理， 但是沒有及時從上游服務(wù)器收 到請求。505（HTTP版本不受支持） 服務(wù)器不支持請求中所用的HTTP協(xié)議版本。系統(tǒng)服務(wù)返回碼（錯誤碼）（700949）:具體接口的錯誤碼945不支持此類文件946響應(yīng)文件不存在947請求數(shù)據(jù)格式錯誤948請求文件名格式不正確949協(xié)議中未定義此類文件名系統(tǒng)服務(wù)預(yù)留返回碼（950999）950鑒權(quán)失敗951文件md5校驗失敗9

9、52格式校驗失敗953請求文件為空999未知錯誤1.5.文件命名規(guī)范文件名使用”進(jìn)行分割，后綴為“json ”或者“ .gz ” ,當(dāng)后綴為 “.gz”時，表示是將json文件進(jìn)行了 gzip壓縮。文件名長度不超過100字節(jié)。文件命名規(guī)范：接口類型（標(biāo)識唯一）命令_請求或響應(yīng)標(biāo)識（REQ或RES）_._時間.json 。類型命令請求標(biāo)識時間后綴REQ|RESyyyyMMddHHmmssSSS .json |.gzyyyyMMddHHmmssSSS .json |.gzREQ|RESyyyyMMddHHmmssSSS .json |.gz1.6.數(shù)據(jù)格式及規(guī)范UTF-8編碼格式的JSON文本，數(shù)

10、據(jù)描述規(guī)范如下:縮寫定義說明M必填O可選根據(jù)實際情況填寫2. 接口定義2.1.接口地址測試地址：正式地址:2.2.核驗駕駛員證的接口請求文件名示例：LICENCE_RZHY_REQ_20180707161021295.json字段描述數(shù)據(jù)類型約束說明idCode證件號碼varchar(32)是name駕駛員名稱varchar(32)否響應(yīng)文件名示例：字段描述數(shù)據(jù)類型約束說明result成功標(biāo)識nu mber是0/1errorMsg失敗原因varchar(512)status駕駛員狀態(tài)varchar(32)1:無證2:申請審核通過3:預(yù)約考試4:獲得證書（有效）5:獲得證書（無效）2.3.核驗車輛運輸證的接口請求文件名示例： 字段描述數(shù)據(jù)類型約束說明licen