API數(shù)據(jù)服務(wù)接口開發(fā)指南

Target-S外部接口說明書上海四鍵信息技術(shù)Fourth上海四鍵信息技術(shù)FourthButton,Inc.變更記錄

日期:2016-05-191引言........................................................概述.................................................名詞縮寫及定義.......................................歷史變更.............................................2開發(fā)標(biāo)準(zhǔn)....................................................通信方式.............................................接口說明.............................................返回參數(shù)..........................................通用返回碼說明....................................3數(shù)據(jù)效勞接口................................................importCustomerAndVHLData〔FTPMonitor-TSS〕.......createLeads〔TSS-TSM〕............................leads需要外部文件導(dǎo)入的，是修改leads....callTheCustomer(TSS-CCA)..........................fishTheCall〔CCA-TSS〕............................4附錄........................................................數(shù)據(jù)構(gòu)造描述.........................................customerVHLData...................................customerInfo......................................VHLInfo...........................................serviceStatus.....................................leadsInfo.........................................返回值處理策略...................................引言概述略名詞縮寫及定義名詞縮寫名詞縮寫定義VIN17VINTSSTarget-SSystemTSMTarget-SModelCCA外部系統(tǒng)，用于撥打給客戶的系統(tǒng)FTPMonitor文件監(jiān)視器，用于監(jiān)測文件夾中是否存在文件，假設(shè)存在文件，則讀取文件內(nèi)容并通知TSS做相應(yīng)處理ESExternalSystem外部系統(tǒng)歷史變更序號1說明變更人時間23455開發(fā)標(biāo)準(zhǔn)通信方式業(yè)務(wù)懇求是協(xié)議懇求，客戶端以POST方式發(fā)送到效勞平臺。參數(shù)名稱和參數(shù)說明中規(guī)定的固定值必需與列表中完全全都〔大小寫敏感。目前接口支持簽名方法：MD5的簽名。接口說明返回參數(shù)字段名類型是否必輸說明responseCodeStringY0，操作失敗響應(yīng)碼見通用響應(yīng)碼說明errorMessageStringNresponseCode0數(shù)不能為空，返回操作失敗緣由通用返回數(shù)據(jù)格式：通用返回碼說明通用返回數(shù)據(jù)格式：響應(yīng)碼響應(yīng)碼說明成功〔接收成功、執(zhí)行成功〕失敗〔接收失敗、執(zhí)行失敗、撥打失敗〕錯誤：缺失必選參數(shù)：%s，請參考API文檔s：%sAPI文檔例3VIN123￥DFG9871SER~23錯誤：參數(shù)%s：%s位數(shù)不正確，請參考API文檔錯誤：完畢時間小于開頭時間，請參考API文檔錯誤：開頭時間大于當(dāng)前時間，請參考API文檔錯誤：參數(shù)%s：%s大于%s，請參考API文檔錯誤：參數(shù)%s：%s不存在，請參考API文檔錯誤：序號%s中缺失必選參數(shù)：%s，請參考API文檔%s中參數(shù)%s：%sAPI文檔例如：“參數(shù)VIN：123￥DFG9871SER~23存在非法字符?！卞e誤：序號%s中參數(shù)%s：%s位數(shù)不正確，請參考API11文檔錯誤：序號%s參數(shù)%s：%s大于%s，請參考API文檔錯誤：序號%s參數(shù)%s：%s不存在，請參考API文檔錯誤：序號%s中參數(shù)%s：%s格式錯誤，請參考API文14檔錯誤：估量總數(shù)：%s，實際總數(shù)%s，請檢查錯誤：號碼%s為空號1717錯誤：號碼%s無人接聽18錯誤：%s:%s不存在19錯誤：參數(shù)%s：%s格式錯誤，請參考API文檔99超時數(shù)據(jù)效勞接口importCustomerAndVHLData〔FTPMonitor-TSS〕importCustomerAndVHLDimportCustomerAndVHLD調(diào)用方FTP效勞TSS接口名稱ataMonitor方監(jiān)視器監(jiān)控某個指定文件夾，假設(shè)有文件，則讀取文件，并調(diào)接口描述TSS數(shù)據(jù)庫中URL/tss/importData/V1/importCustomerAndVHLDataRESTFulJSON接口類型式V1POST版本號法參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明型輸輸入?yún)?shù)客戶和車輛配對總total 總數(shù) int Y計customerVHL客戶、車List<cuY數(shù)據(jù)類型參照輛、效勞輛、效勞列表stomerVHLData>參數(shù)名稱數(shù)據(jù)類型必 參數(shù)說明輸參數(shù)代碼輸出參數(shù)

responseCode

返回碼 int Y 參照返回值說明errorMessage

錯誤信息string

當(dāng)懇求特別時，將Nerror返回值說明responseCod序號e

errorMessage 說明1 0 無錯誤：缺失必選參2 2數(shù)：count錯誤：缺失必選參

count3 2 數(shù) ：缺失customerVHLListcustomerVHLList錯誤：缺失必選參4 2數(shù)：NO錯誤：參數(shù)NO：%s5 3存在非法字符，請參

NONO考API%s中缺失9 必選參數(shù)：customerInfo%scustomerInfo中的全部必輸9 必選參數(shù)：項一樣，都有缺失必選項參customerName%s中參數(shù)

數(shù)錯誤8

ownership：%s存在ownership范圍如下：非法字符，請參考1：個人；2：公司API9 1010 9

%s中參數(shù)IDType：%sAPI檔%s中缺失必選參數(shù)：VHLInfo

IDType范圍如下：1：身份證；2：組織機構(gòu)代碼證；3：護照；4：軍官證11 9

%s中缺失必選參數(shù)：VIN

VHLInfo，都有缺失必選項參數(shù)錯誤12 10

%s中參數(shù)參數(shù)VIN值由字母和數(shù)字組VIN：%s存在非法字成符，請參考API文檔%s中參數(shù)1311VIN：%s17請參考API文檔錯誤：序號%s參數(shù)VHLInfoBand、Series、1413OEM：%sTypeColordealerName與參考APIOEM%s中參數(shù)1514PurcaseDate：%s格式為YYYY/MM/DDAPI文檔%s中缺失169必選參數(shù)：serviceStatus%s中缺失serviceStatus中的全部必179必選參數(shù)：輸項一樣，都有缺失必選項isFreeService參數(shù)錯誤%s中參數(shù)isFreeService1810isFreeService：%s存在非法字符，請參字serviceStatus中全部int考API型的數(shù)據(jù)都有此錯誤1914%s中參數(shù)格式為YYYY/MM/DDremainingServiceDate：%s請參考API2015錯誤：估量總數(shù)：[total]，實際總數(shù)：例：錯誤：估量總數(shù)：1000，實[]，請檢查際總數(shù)：990，請檢查2199超時超時createLeads〔TSS-TSM〕接口名稱接口名稱createLeads調(diào)用方TSS效勞方TSMTSS將最的客戶靜態(tài)信息、車輛靜態(tài)信息和車輛效勞狀態(tài)信接口描述息導(dǎo)入到TSM，生成對應(yīng)的LeadsURL/tsm/createLeads/V1/createLeadsRESTFulJSON接口類型式V1POST版本號法參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明型輸Leads的輸入?yún)?shù)total總數(shù)intY總數(shù)customerVHL客戶、車List<cuY數(shù)據(jù)類型參照List輛、效勞stomerV狀態(tài)信息列表狀態(tài)信息列表HLData>參數(shù)代碼 參數(shù)名稱數(shù)據(jù)類型必輸responseCode

返回碼

int Y 參照返回值說明輸出參數(shù)

errorMessage

錯誤信息string

當(dāng)懇求特別時，將Nerror生 成total

Leads總int數(shù)對應(yīng)的List<le

Ytotal0leadsList Leads信adsInfo N 數(shù)據(jù)類型參照息 >返回值說明responseCod序號e

errorMessage 說明1 0 無錯誤：缺失必選參2 2數(shù)：count錯誤：缺失必選參3 2數(shù)

count缺失customerVHLListcustomerVHLList錯誤：缺失必選參4 2數(shù)：NO錯誤：參數(shù)NO：%s

NO5 3 存在非法字符，請參參數(shù)NO考API%s中缺失6 9必選參數(shù)：customer%scustomer中的全部必輸項相7 9 必選參數(shù)：同，都有缺失必選項參數(shù)錯customerName%s中參數(shù)ownership：%s8 10非法字符，請參考API%s中參數(shù)

誤ownership1：個人；2：公司IDTypeIDType9 10 ：%s12：組織機構(gòu)代IDType10 9

符，請參考API文檔%s中缺失必選參數(shù)：VHLInfo

碼證；3：護照；4：軍官證11 9

錯誤序號%s中缺失VHLInfo中的全部必輸項相必選參數(shù)：VIN 同，都有缺失必選項參數(shù)錯誤%s中參數(shù)10VIN：%s符，請參考API文檔%s中參數(shù)

VIN成11 VIN：%s17請參考API文檔%s參數(shù)VHLInfo中Band、Series、13 OEM：%s不存在，請TypeColordealerName參考API%s中參數(shù)

OEM一樣，都有不存在錯誤15 14

PurcaseDate：%sAPI文檔%s中缺失

格式為YYYY/MM/DD9 必選參數(shù)：serviceStatus%sserviceStatus中的全部必9 必選參數(shù)：輸項一樣，都有缺失必選項isFreeService 參數(shù)錯誤18 10

%s中參數(shù)參數(shù)isFreeService必需數(shù)isFreeService%s字存在非法字符，請參考API%s中參數(shù)remainingServiceDserviceStatus中全部int型的數(shù)據(jù)都有此錯誤1914ate：%s格式為YYYY/MM/DD請參考API文檔錯誤：估量總數(shù)：例：2015[total]，實際總數(shù)：錯誤：估量總數(shù)：1000，實[]，請檢查際總數(shù)：990，請檢查2199超時超時callTheCustomer(TSS-CCA)接口名稱接口名稱callTheCustomer調(diào)用方TSS效勞方CCA接口描述TSSCCA，觸發(fā)CCA撥打給客戶URL/cca/cti/V1/callTheCustomerRESTFulJSON接口類型式V1POST版本號法參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明型輸輸入?yún)?shù)VIN車架號stringYcallNumber號碼stringY需要撥打的號碼參數(shù)代碼 參數(shù)名稱數(shù)據(jù)類 必型 輸

參數(shù)說明輸出參數(shù)

responseCode

返回碼 int Y 參照返回值說明errorMessage

錯誤信息string

當(dāng)懇求特別時，將Nerror返回值說明responseCod序號e

errorMessage 說明1 0 無錯誤：缺失必選參2 2數(shù)：VIN錯誤：缺失必選參3 2數(shù)：callNumber錯誤：參數(shù)

VIN缺失callNumbercallNumber：%s存在號碼存在～！@#￥%&×4 3非法字符，請參考API5 16 %s為空號

〔〕等非法字符6

%s無人接聽7799超時超時fishTheCall〔CCA-TSS〕接口名稱 fishTheCall 調(diào)用方CCA 效勞方TSS接口描述

銷售與客戶溝通完畢后，將通話開頭時間、完畢時間返回給TSSURL /tss/cti/V1/fishTheCall接口類型

RESTFul

JSON式V1版本號

POST法參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明型輸VIN車架號stringY輸入?yún)?shù)callNumber號碼stringY需要撥打的號碼startDate通話開頭時間datetimeYYYYY/MM/DDHH:mm:SSendDate通話開頭完畢時間datetimeYYYYY/MM/DDHH:mm:SS參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明輸出參數(shù)型輸responseCod返回碼intY參照返回值說明eerrorMessage

錯誤信息string

當(dāng)懇求特別時，將Nerror返回值說明responseCod序號e

errorMessage 說明1 0 無錯誤：缺失必選參2 2數(shù)：VIN錯誤：缺失必選參3 2數(shù)：callNumber錯誤：缺失必選參4 2數(shù)：startDate錯誤：缺失必選參5 2數(shù)：endDate

VIN缺失callNumber缺失startDate缺失endDate6 18 錯誤：VIN:%s錯誤：參數(shù)callNumber：%s存在號碼存在～！@#￥%&×7 3非法字符，請參考API

〔〕等非法字符8

錯誤：參數(shù)startDate：%s格式

YYYY/MM/DDHH:mm:SSAPI檔錯誤：參數(shù)919endDate：%s誤，請參考API文檔YYYY/MM/DDHH:mm:SS1099超時超時searchPastPackage〔TSS-ES〕接口名稱接口名稱searchPastPackage調(diào)用方TSS效勞方ESTSS通過VIN查詢外部系統(tǒng)，獵取到該VIN對應(yīng)的歷史套餐列接口描述表URL/es/vehicle/V1/searchPastPackageRESTFulJSON接口類型式V1POST版本號法參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明輸入?yún)?shù)型輸VIN車架號stringY參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明型輸輸出參數(shù)responseCod返回碼intY參照返回值說明e號 errorMessage 說明e10無218錯誤：VIN:%s32錯誤：缺失必選參數(shù)：packageList，請參考API文檔499超時超時errorMessag當(dāng)懇求特別時，將errorMessag當(dāng)懇求特別時，將錯誤信息string Neerror參照當(dāng)list<paresponseCode0packageList套餐列表Nckage>packageList不為空返回值說明responseCod序接口名稱接口名稱searchServiceStatus調(diào)用方TSS效勞方ESTSS通過VIN查詢外部系統(tǒng)，獵取到該VIN對應(yīng)的當(dāng)前效勞狀接口描述態(tài)信息URL/es/vehicle/V1/searchServiceStatusRESTFulJSON接口類型式V1POST版本號法參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明輸入?yún)?shù)型輸VIN車架號stringY參數(shù)代碼參數(shù)名稱數(shù)據(jù)類必參數(shù)說明型輸responseCod返回碼intY參照返回值說明eerrorMessag輸出參數(shù)錯誤信息stringN當(dāng)懇求特別時，將eerror參照當(dāng)serviceStatserviceresponseCode0效勞狀態(tài)NusStatusserviceStatus不為空返回值說明responseCod序號 errorMessage 說明e10無218錯誤：VIN:%s32錯誤：缺失必選參數(shù)：serviceStatus，請參考請參考API文檔499超時超時附錄數(shù)據(jù)構(gòu)造描述customerVHLData列表名列表名customerVHLData必No參數(shù)代碼參數(shù)名稱數(shù)據(jù)類型參數(shù)說明選1NO序號intYcustomerI2客戶靜態(tài)信息customerY參照nfo車輛靜態(tài)信息VHLInfoY參照車輛效勞狀態(tài)serviceSY參照信息tatus4.1.2列表名列表名customerInfo必No參數(shù)代碼參數(shù)名稱數(shù)據(jù)類型參數(shù)說明選customerITSS1IDstringN/YD 必需有唯一數(shù)值customerN2ame

客戶名稱 string YrenewalTi3mesmobileNum4ber

續(xù)約次數(shù)聯(lián)系

int NstringYintstringYintN1：身份證；2：組織34：軍官證stringNintN1：男；2：女intY1：個人；2：公司stringNstringNstringNstringNstringNIDNumbergenderownershiphomeNumbe9rbacKUpNum10ber1bacKUpNum11ber212emailemergency13Contact

家庭備用1備用2郵箱緊急聯(lián)系人stringNstringN/Y當(dāng)賬號類型為公司時，該字段為必輸字段stringN/Y當(dāng)賬號類型為公司時，該字段為必輸字段stringN/Y當(dāng)賬號類型為公司時，該字段為必輸字段emergency14emergency14ContactNu緊急聯(lián)系人stringNmber15wechat微信號companyNa16公司名稱mecompanyNu17公司mbercompanyAd18公司地址dress列表名列表名VHLInfo必No參數(shù)代碼參數(shù)名稱數(shù)據(jù)類型參數(shù)說明選1VIN車架號stringY2OEM廠商stringY3Band品牌stringY4Series車系stringY5Type車型stringY66Color顏色stringYdealerNam7經(jīng)銷商名稱stringYedealerPho8經(jīng)銷商stringYneNumberdealerAdd9經(jīng)銷商地址stringYress10License車牌號stringN11MDN車載stringNPurcaseDa12購置時間datetimeYYYYY/MM/DDte列表名serviceStatus列表名serviceStatus必No參數(shù)代碼參數(shù)名稱數(shù)據(jù)類型參數(shù)說明isFreeSer1是否處于免費效勞期viceremaining2ServiceDa效勞到期時間teactivePro3當(dāng)前套餐名稱duct選intY1：在；2：不在datetim