《api數(shù)據(jù)服務(wù)接口開發(fā)指南》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在工程資料-天天文庫。

1、word完美格式Target-S外部接口說明書上海四鍵信息技術(shù)FourthButton,Inc.日期:2016-05-19精心整理學(xué)習(xí)幫手word完美格式變更記錄序號說明變更人時間精心整理學(xué)習(xí)幫手word完美格式目錄1引言11.1概述11.2名詞縮寫及定義11.3歷史變更12開發(fā)規(guī)范22.1通信方式22.2接口說明22.2.1返回參數(shù)22.2.2通用返回碼說明23數(shù)據(jù)服務(wù)接口43.1importCustomerAndVHLData（FTPMonitor-TSS）43.2createLeads（TSS-TSM）53.3l

2、eads需要外部文件導(dǎo)入的，是修改leads狀態(tài)碼？73.4callTheCustomer(TSS-CCA)83.5fishTheCall（CCA-TSS）94附錄114.1數(shù)據(jù)結(jié)構(gòu)描述114.1.1customerVHLData114.1.2customerInfo114.1.3VHLInfo124.1.4serviceStatus134.1.5leadsInfo134.2HTTP返回值處理策略14精心整理學(xué)習(xí)幫手word完美格式1引言1.1概述略1.2名詞縮寫及定義名詞縮寫定義VIN17位國際VIN碼規(guī)則TSSTa

3、rget-SSystemTSMTarget-SModelCCA外部系統(tǒng)，用于撥打電話給客戶的系統(tǒng)FTPMonitor文件監(jiān)視器，用于監(jiān)測文件夾中是否存在文件，如果存在文件，則讀取文件內(nèi)容并通知TSS做相應(yīng)處理ESExternalSystem外部系統(tǒng)1.3歷史變更序號說明變更人時間12345精心整理學(xué)習(xí)幫手word完美格式1開發(fā)規(guī)范1.1通信方式1）業(yè)務(wù)請求是HTTP協(xié)議請求，客戶端以POST方式發(fā)送到服務(wù)平臺。2）參數(shù)名稱和參數(shù)說明中規(guī)定的固定值必須與列表中完全一致（大小寫敏感）。3）目前接口支持簽名方法：MD5的簽名

4、。1.2接口說明1.2.1返回參數(shù)通用返回數(shù)據(jù)格式：字段名類型是否必輸說明responseCodeStringY請求操作相應(yīng)碼。操作成功返回0，操作失敗響應(yīng)碼見通用響應(yīng)碼說明errorMessageStringN當(dāng)responseCode不為0時，該參數(shù)不能為空，返回操作失敗原因1.2.2通用返回碼說明響應(yīng)碼說明0成功（接收成功、執(zhí)行成功）1失敗（接收失敗、執(zhí)行失敗、撥打失敗）2錯誤：缺失必選參數(shù)：%s，請參考API文檔3錯誤：參數(shù)%s：%s存在非法字符，請參考API文檔例如：“參數(shù)VIN：123￥DFG9871SER

5、~23存在非法字符?！?錯誤：參數(shù)%s：%s位數(shù)不正確，請參考API文檔5錯誤：結(jié)束時間小于開始時間，請參考API文檔6錯誤：開始時間大于當(dāng)前時間，請參考API文檔7錯誤：參數(shù)%s：%s大于%s，請參考API文檔8錯誤：參數(shù)%s：%s不存在，請參考API文檔9錯誤：序號%s中缺失必選參數(shù)：%s，請參考API文檔10錯誤：序號%s中參數(shù)%s：%s存在非法字符，請參考API文檔例如：“參數(shù)VIN：123￥DFG9871SER~23存在非法字符?！?1錯誤：序號%s中參數(shù)%s：%s位數(shù)不正確，請參考API文檔12錯誤：序號%

6、s參數(shù)%s：%s大于%s，請參考API文檔13錯誤：序號%s參數(shù)%s：%s不存在，請參考API文檔14錯誤：序號%s中參數(shù)%s：%s格式錯誤，請參考API文檔15錯誤：預(yù)計總數(shù)：%s，實際總數(shù)%s，請檢查精心整理學(xué)習(xí)幫手word完美格式16錯誤：號碼%s為空號17錯誤：號碼%s無人接聽18錯誤：%s:%s不存在19錯誤：參數(shù)%s：%s格式錯誤，請參考API文檔99超時精心整理學(xué)習(xí)幫手word完美格式1數(shù)據(jù)服務(wù)接口1.1importCustomerAndVHLData（FTPMonitor-TSS）接口名稱importC

7、ustomerAndVHLData調(diào)用方FTPMonitor服務(wù)方TSS接口描述監(jiān)視器監(jiān)控某個指定文件夾，如果有文件，則讀取文件，并調(diào)用該接口，將客戶數(shù)據(jù)和對應(yīng)的車輛數(shù)據(jù)存儲到TSS數(shù)據(jù)庫中URL/tss/importData/V1/importCustomerAndVHLData接口類型RESTFul內(nèi)容格式JSON版本號V1請求方法POST輸入?yún)?shù)參數(shù)代碼參數(shù)名稱數(shù)據(jù)類型必輸參數(shù)說明total總數(shù)intY客戶和車輛配對總計customerVHLDataList客戶、車輛、服務(wù)狀態(tài)信息列表List

8、HLData>Y數(shù)據(jù)類型參照4.1.1輸出參數(shù)參數(shù)代碼參數(shù)名稱數(shù)據(jù)類型必輸參數(shù)說明responseCode返回碼intY參照返回值說明errorMessage錯誤信息stringN當(dāng)請求異常時，將返回error信息返回值說明序號responseCodeerrorMessage說明10無22錯誤：缺失必選參數(shù)：count缺失coun