APPAPP接口規范文檔v.1.0.0{北京天晴APP接口規范文檔}手機客戶端接口文檔文件狀態：[]草稿[V]正式發布[]正在修改文件標識：當前版本：1.0作者：北京天晴完成日期：

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

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

獲取列表對象信息2.2.1請求格式URL支持格式JOSNHttp請求方式POST是否登錄驗證請求數限制2.2.2參數說明參數名必選類型及范圍說明xxxtrueString用戶名Pagefalseint第幾頁，不傳遞默認第一頁Sizefalseint一頁多少條，不傳遞默認20條正常返回結果返回鍵■返回值說明resultString結果代碼信號ResponseObject響應體LastUpdateTimeString最舟-條更新時間根據此時間判斷新舊ThisPageNumberint當前頁條數判斷是否為空，是否有卜貞「DataListArray[Object]對象列表時間倒序排列{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}]}}錯誤返回列表詳見：通用錯誤返回列表三、操作類接口3.1新增操作3.1.1接口說明URL支持格式JOSNHttp請求方式POST是否登錄驗證請求數限制3.1.2參數說明參數名必選類型及范圍說明xxxtrueString用戶名xxxtrueStringxxxtrueStringxxxtrueString3.1.3正常返回結果返回鍵返回值說明 ■resultString結果代碼信號ResponseObject響應體idint增數據的ID或者標志textString操作提示語如添加客戶成功，可為空{result :ok,"Response":{"id":1,"text":"")

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

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

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

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

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