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

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

2、（示例）必填備注RequestHeadersbi nfile-md5請(qǐng)求文件二進(jìn)制流的MD5摘要，示例：bcf7837571fab538772f65b137b71b9dM文件md5摘要，用于數(shù)據(jù)元 整性校驗(yàn)bin file-gzitrue 或者 flaseO響應(yīng)是否采用 GZIP壓縮Pbin file-aut hTICKETM單位標(biāo)識(shí)鑒權(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ī)范，詳見(jiàn)2.5Resp onse：請(qǐng)求header屬性值（示例）必填備注ResponseHeadersbi nfile-md5響應(yīng)文件二進(jìn)制流的MD5摘要，示例：bef7837571fab538772f65b137b71b9dM文件md5摘要，用于數(shù)據(jù)元 整性校驗(yàn)Conten t-Disp ositi onattaehme nt;file name=ZW_CZKKZCX_RES_2015061710233.js on1 M與HTTP協(xié)議規(guī)定相冋，file name=返回的文件名文件命名規(guī)范，詳見(jiàn) 2.5Conten t-E neo dinggzipO與

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

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

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

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

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

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

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