APPAPP接口規(guī)范文檔v.1.0.0{北京天晴APP接口規(guī)范文檔}手機(jī)客戶端接口文檔文件狀態(tài)：[]草稿[V]正式發(fā)布[]正在修改文件標(biāo)識：當(dāng)前版本：1.0作者：北京天晴完成日期：

版本歷史版本/狀態(tài)作者參與后起止日期備注V1.0/草稿韓磊移動小組目錄TOC\o"1-5"\h\z一、概述 1有關(guān)接口 1\o"CurrentDocument"接口是純數(shù)據(jù)的交互 1\o"CurrentDocument"接口的分類 1\o"CurrentDocument"查詢類接口 1\o"CurrentDocument"操作類接口 1\o"CurrentDocument"上傳下載類接口 1\o"CurrentDocument"推送類接口 1二、查詢類接口格式規(guī)范 1獲取單條^^象信息 1\o"CurrentDocument"請求格式 1\o"CurrentDocument"參數(shù)說明 2\o"CurrentDocument"正常返回結(jié)果 2\o"CurrentDocument"獲取列表^?象信息 3\o"CurrentDocument"請求格式 3\o"CurrentDocument"參數(shù)說明 3\o"CurrentDocument"正常返回結(jié)果 3三、操作類接口 4新增操作 4\o"CurrentDocument"接口說明 4\o"CurrentDocument"參數(shù)說明 4\o"CurrentDocument"正常返回結(jié)果 4\o"CurrentDocument"錯(cuò)誤返回列表 5\o"CurrentDocument"修改操作 5\o"CurrentDocument"接口說明 5\o"CurrentDocument"參數(shù)說明 5\o"CurrentDocument"正常返回結(jié)果 5\o"CurrentDocument"錯(cuò)誤返回列表 5\o"CurrentDocument"刪除操作 6\o"CurrentDocument"接口說明 6\o"CurrentDocument"參數(shù)說明 6\o"CurrentDocument"正常返回結(jié)果 6\o"CurrentDocument"錯(cuò)誤返回列表 6四、上傳下載類 7上傳文件 7\o"CurrentDocument"接口說明 7\o"CurrentDocument"參數(shù)說明 7\o"CurrentDocument"正常返回結(jié)果 7\o"CurrentDocument"錯(cuò)誤返回列表 7\o"CurrentDocument"下載文件 7\o"CurrentDocument"接口說明 7\o"CurrentDocument"參數(shù)說明 8\o"CurrentDocument"正常返回結(jié)果 8\o"CurrentDocument"錯(cuò)誤返回列表 8五、推送類接口 8推送消息 8\o"CurrentDocument"接口說明 8\o"CurrentDocument"參數(shù)說明 8\o"CurrentDocument"正常返回結(jié)果 9\o"CurrentDocument"錯(cuò)誤返回列表 9六、通用返回格式 9正確返回 9\o"CurrentDocument"接口說明 9\o"CurrentDocument"參數(shù)說明 9\o"CurrentDocument"正常返回結(jié)果 9\o"CurrentDocument"錯(cuò)誤返回列表 10\o"CurrentDocument"錯(cuò)誤返回 10\o"CurrentDocument"接口說明 10\o"CurrentDocument"參數(shù)說明 10\o"CurrentDocument"正常返回結(jié)果 10\o"CurrentDocument"錯(cuò)誤返回列表 10七、附錄 11\o"CurrentDocument"通用錯(cuò)誤返回列表 11\o"CurrentDocument"URL地址信息 11\o"CurrentDocument"主機(jī)地址 11URL列表 11\o"CurrentDocument"安全機(jī)制 11\o"CurrentDocument"驗(yàn)證簽名機(jī)制 11\o"CurrentDocument"其他 12\o"CurrentDocument"列表數(shù)據(jù)為空的返回 12APPAPP接口規(guī)范文檔v.1.0.0、概述有關(guān)接口接口是純數(shù)據(jù)的交互APP接口是移動設(shè)備和業(yè)務(wù)之間進(jìn)行通信的途徑。實(shí)質(zhì)就是以特定的規(guī)則通過接口直接操作數(shù)據(jù)庫的增刪改查。接口的分類查詢類接口查詢類接口是指客戶端傳遞一些參數(shù)， 服務(wù)端根據(jù)參數(shù)依據(jù)需求， 前往數(shù)據(jù)庫查詢需要的結(jié)果返回?cái)?shù)據(jù)的一類接口。返回類型一般有兩種。第一種是返回一個(gè)對象，第二種是返回一個(gè)數(shù)組對象。第一種比如登陸，客戶端把用戶名密碼上傳到接口，服務(wù)器返回用戶的個(gè)人信息。第二種比如獲取客戶，客戶端把用戶的身份信息上傳到接口， 服務(wù)器返回此身份下的所有客戶數(shù)組集合。操作類接口操作類接口是指，客戶端通過接口進(jìn)行一些增刪改的操作。 比如新增一個(gè)客戶，修改客戶信息，或者刪除一個(gè)客戶。服務(wù)器一般返回執(zhí)行的狀態(tài)， 有的需要返回執(zhí)行結(jié)果的一些信息，比如新增客戶后，返回客戶的 ID。上傳下載類接口上傳下載類接口是涉及到文件傳輸?shù)慕涌凇?比如上傳頭像，需要上傳圖片到服務(wù)器， 服務(wù)端根據(jù)需求響應(yīng)保存并返回結(jié)果。 比如客戶端需要顯示用戶頭像， 需要讀取網(wǎng)絡(luò)圖片文件，在手機(jī)上進(jìn)行顯示。推送類接口除了客戶端主動去請求服務(wù)端，獲取需要信息之外。有時(shí)候，也存在服務(wù)端有消息需要通知客戶端的情況，這時(shí)候就是服務(wù)端向客戶端發(fā)送消息。 這類需求可以通過客戶端短時(shí)間類循環(huán)請求解決，也可以通過第三方專業(yè)推送解決。也可以通過自己使用 socket或者xmpp等協(xié)議進(jìn)行開發(fā)。、查詢類接口格式規(guī)范獲取單條對象信息請求格式URL支持格式JOSN

Http請求方式POST是否登錄驗(yàn)證請求數(shù)限制2.1.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名2.1.3正常返回結(jié)果返回鍵返回值說明resultString結(jié)果代碼信號ok結(jié)果成功，fail結(jié)果失敗ResponseObject響應(yīng)體Key1int響應(yīng)字段值Key2String響應(yīng)字段值Key3Object響應(yīng)字段值可以依然包含對象體Key3_Key1int響應(yīng)字段值{"result":"ok","Response":{"userName":"Mary","sex”:1,"Address":[{"city":"JiNan"}，{"county":"LiXia"}]}}2.1.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表

獲取列表對象信息2.2.1請求格式URL支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制2.2.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名Pagefalseint第幾頁，不傳遞默認(rèn)第一頁Sizefalseint一頁多少條，不傳遞默認(rèn)20條正常返回結(jié)果返回鍵■返回值說明resultString結(jié)果代碼信號ResponseObject響應(yīng)體LastUpdateTimeString最舟-條更新時(shí)間根據(jù)此時(shí)間判斷新舊ThisPageNumberint當(dāng)前頁條數(shù)判斷是否為空，是否有卜貞「DataListArray[Object]對象列表時(shí)間倒序排列{result:ok,"Response":{"LastUpdateTime":"2012-12-1122:01:09”,"ThisPageNumber":2,"DataList":[{"id":1,"date":"2014-07-24","detail":,"points":50},{"id":2,"date":"2014-07-24”,"detail":,"points":50}]}}錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表三、操作類接口3.1新增操作3.1.1接口說明URL支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制3.1.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名xxxtrueStringxxxtrueStringxxxtrueString3.1.3正常返回結(jié)果返回鍵返回值說明 ■resultString結(jié)果代碼信號ResponseObject響應(yīng)體idint增數(shù)據(jù)的ID或者標(biāo)志textString操作提示語如添加客戶成功，可為空{(diào)result :ok,"Response":{"id":1,"text":"")

3.1.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表3.2修改操作3.2.1接口說明URL支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制3.2.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名xxxtrueStringxxxtrueStringxxxtrueString3.2.3正常返回結(jié)果返回鍵返回值說明resultString結(jié)果代碼信號ResponseObject響應(yīng)體idint數(shù)據(jù)的ID或者標(biāo)志textString操作提示語如修改客戶成功，可為空{(diào)result :ok,"Response":{"id":1,"text":""}}3.2.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表

3.3刪除操作3.3.1接口說明URL支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制3.3.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名xxxtrueString3.3.3正常返回結(jié)果返回鍵返回值說明resultString結(jié)果代碼信號ResponseObject響應(yīng)體idint數(shù)據(jù)的ID或者標(biāo)志textString操作提示語如刪除客戶成功，可為空{(diào)result :ok,"Response":{"id":1,"text":"親，刪除客戶成功}}"3.3.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表

四、上傳下載類4.1上傳文件4.1.1接口說明URL支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制4.1.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名xxxtrueFile值為文件類型，處理向Web中的表單FILE一樣4.1.3正常返回結(jié)果返回鍵返回值說明 ■resultString結(jié)果代碼信號ResponseObject響應(yīng)體filePathString文件存放的絕對路徑上傳{result :ok,"Response":{"filePath":"/logo.gif"}}4.1.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表4.2下載文件4.2.1接口說明URL

支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制4.2.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString文件網(wǎng)絡(luò)絕對路徑4.2.3正常返回結(jié)果返回鍵返回值說明 ■確保文件可以正常訪1可下載4.2.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表五、推送類接口5.1推送消息5.1.1接口說明URL支持格式JOSNHttp請求方式POST是否登錄驗(yàn)證請求數(shù)限制5.1.2參數(shù)說明參數(shù)名必選類型及范圍說明

5.1.3正常返回結(jié)果返回鍵返回值說明 ■5.1.4錯(cuò)誤返回列表詳見：通用錯(cuò)誤返回列表六、通用返回格式6.1正確返回6