1、CmsTop端數(shù)據(jù)交互規(guī)范思拓合眾科技目錄目錄2草稿 正式發(fā)布 正在修改文檔標(biāo)識(shí)cmstop / mobile當(dāng)前版本V1.0修改日期2013-01-21數(shù)據(jù)交互說明1數(shù)據(jù)接口說明3尺寸定義8834 服務(wù)端配置881數(shù)據(jù)交互說明使用HTTP 協(xié)議進(jìn)行數(shù)據(jù)通信；客戶端使用GET 或T 方式發(fā)送請(qǐng)求；服務(wù)器端使用JSON 格式返回?cái)?shù)據(jù)；所有數(shù)據(jù)屬性名稱定義均使用小寫表示；所有列表類接口中均由一個(gè)time 字段（時(shí)間戳）用來標(biāo)識(shí)上次獲取數(shù)據(jù)的時(shí)間，下次獲取數(shù)據(jù)時(shí)作為參數(shù)傳遞獲取較新的內(nèi)容，同時(shí)返回一個(gè)新的 time 值，如果 time 為 0，則忽略該值。所有接口均有一個(gè)type 字段,用來標(biāo)識(shí)請(qǐng)求

2、的來源.type 是 String 類型,包括如下值(全字母小寫)1.1 錯(cuò)誤信息規(guī)范服務(wù)端返回的數(shù)據(jù)總是包含se 字段。當(dāng)se 值為true 時(shí)接口調(diào)用成功，返回類似如下結(jié)構(gòu)數(shù)據(jù)：其中message 為成功提示信息（可選），data 為數(shù)據(jù)，不同接口返回的具體數(shù)據(jù)不同，請(qǐng)以接口返回?cái)?shù)據(jù)為準(zhǔn)，這里僅做示例說明。當(dāng)se 值為false 時(shí)接口調(diào)用失敗，返回如下結(jié)構(gòu)數(shù)據(jù)：se: false,message: this is the error messagese: true,message: this is the sucdata: s message,mobile版(默認(rèn))ipadipad 客戶

3、端pad其他pad 客戶端其中error 屬性為錯(cuò)誤信息。發(fā)生錯(cuò)誤時(shí)的返回格式總是如此，請(qǐng)從error 中獲取具體的錯(cuò)誤。1.2 接口以下接口中以代替接口進(jìn)行書寫；地址返回?cái)?shù)據(jù)均指請(qǐng)求成功時(shí)返回的正常數(shù)據(jù)，請(qǐng)求出錯(cuò)時(shí)請(qǐng)參考“錯(cuò)誤信息規(guī)范”；數(shù)據(jù)接口說明會(huì)員會(huì)員使用接口（客戶端二期用戶交互接口文檔，以下簡(jiǎn)稱“接口”，2.2用戶接口）的返回值進(jìn)行。接口地址：?app=mobile&controller=member&action=register接受參數(shù)：返回?cái)?shù)據(jù)：se : true,data : userid : 1, username : cmstop, : HYPERLINK mailto:

4、webmastercmstop.dev webmast HYPERLINK mailto:webmastercmstop.dev ercmstop.dev,avatar : ,參數(shù)方法名稱備注usernameT用戶名必選，使用“接口”2.2 返回的數(shù)據(jù) loginnamepasswordTT郵箱必選，使用“接口”2.2 返回的數(shù)據(jù) loginname+“univs.user”必選，用戶在客戶端輸入的。返回字段說明：2.1.2 會(huì)員登錄接口地址：?app=mobile&controller=member&action=login接受參數(shù)：返回字段說明：返回?cái)?shù)據(jù)：se : true,參數(shù)useri

5、d名稱 用戶備注username用戶名用戶郵箱avatar頭像為空，表示沒有頭像userauth用戶 auth用于后續(xù)數(shù)據(jù)提交時(shí)驗(yàn)證，在進(jìn)行本文檔 2.2 和 2.3 時(shí)使用參數(shù)方法名稱備注username用戶名T必選，“接口”2.3 登錄接口返回的 loginName進(jìn) 行登錄。passwordT必選，用戶在客戶端輸入的。參數(shù)userid名稱用戶備注username用戶名用戶郵箱avatar頭像如果為空，表示沒有頭像userauth用戶 auth用于后續(xù)數(shù)據(jù)提交時(shí)驗(yàn)證userauth : 6yrhndmkdi8e73jdmr設(shè)置意見反饋意見反饋中的上傳請(qǐng)使用標(biāo)準(zhǔn)的上傳接口處理。接口地址：?a

6、pp=mobile&controller=index&action=feedback接受參數(shù)：返回?cái)?shù)據(jù)：評(píng)論評(píng)論列表評(píng)論列表按發(fā)布排序。se : true,message : 提交成功參數(shù)方法名稱備注userauthT用戶 auth必選contentT意見內(nèi)容必選T郵箱可選，如果已登錄，可自動(dòng)填寫用戶郵箱app_verT應(yīng)用版本必選，標(biāo)識(shí)用戶使用的應(yīng)用版本system_ver系統(tǒng)版本必選，標(biāo)識(shí)用戶使用機(jī)系統(tǒng)和具體的版本號(hào)Tdata : userid : 1, username : cmstop, : HYPERLINK mailto:webmastercmstop.dev webmast HY

7、PERLINK mailto:webmastercmstop.dev ercmstop.dev,avatar : ,userauth : 6yrhndmkdi8e73jdmr接口地址：?app=mob接受參數(shù)：ment&action=index參數(shù)方法名稱備注topicidGET評(píng)論話題必選pageGET分頁頁碼可選，默認(rèn)取第一頁timeGET更新標(biāo)識(shí)上次獲取到的數(shù)據(jù)更新標(biāo)識(shí)，用于獲取更新內(nèi)容返回字段說明：參數(shù)名稱備注more是否 用于判斷是否顯示“”time更新標(biāo)識(shí)數(shù)據(jù)更新標(biāo)識(shí)，用于下次獲取較新數(shù)據(jù)commentid評(píng)論topicid評(píng)論followid回復(fù)評(píng)論如果沒有為 0content評(píng)

8、論內(nèi)容createdby評(píng)論人會(huì)員created評(píng)論時(shí)間時(shí)間戳date評(píng)論時(shí)間友好的時(shí)間格式，如：10 秒前，1 小時(shí)前，1 天前使用“接口”2.8.4，傳入 username 值獲取昵稱nickname評(píng)論人usernamesus狀態(tài)1 是待審，2 是通過，注：返回的都是通過審核的supports頂次數(shù)數(shù)字reports次數(shù)數(shù)字sensitive是否敏感如果包含為 1，否則為 0istop是否置頂該字段未生效anonymous是否如果是評(píng)論，該字段為 1ip評(píng)論人 IP 地址location評(píng)論人 IP 物理地址中文地址，如：市follow的內(nèi)容如果 followid 不為 0 時(shí)，才會(huì)有此

9、字段followdata評(píng)論的蓋樓信息ipad 版新增,用于生成蓋樓返回?cái)?shù)據(jù)：se : true,more : true,time : 1349863981,data : commentid : 1,topicid : 1,followid : 0,content : 評(píng)論內(nèi)容,createdby : 1,created : 1357612591, / 時(shí)間截形式的date : 32 分鐘前, / 多少秒前，友好的時(shí)間格式nickname : cmstopsus : 2,supports : 0,reports : 0,sensitive : 0, / 是否包含istop : 0,anonym

10、ous : 0,ip : ,location : LAN,followdata: commentid: 3, topicid:1,content : 評(píng)論內(nèi)容,createdby : 1,date : 28 分鐘前, / 多少秒前，友好的時(shí)間格式nickname : cmstop, commentid: 4, topicid:1,content : 評(píng)論內(nèi)容,createdby : 1,date : 24 分鐘前, / 多少秒前，友好的時(shí)間格式nickname : cmstop,commentid : 2,topicid : 1,followid : 0,content : 評(píng)論內(nèi)容,crea

11、tedby : 1,created : 1357612591, / 時(shí)間截形式的date : 32 分鐘前, / 多少秒前，友好的時(shí)間格式nickname : cmstopsus : 2,supports : 0,reports : 0,sensitive : 0, / 是否包含istop : 0,anonymous : 0,ip : ,location : LAN, follow : commentid : 1,topicid : 1,followid : 0,content : 評(píng)論內(nèi)容,2.3.2 發(fā)布評(píng)論接口地址：?app=mob接受參數(shù)：ment返回?cái)?shù)據(jù)：se : true,mess

12、age : 提交成功參數(shù)userauth方法名稱用戶 auth備注必選，用來驗(yàn)證用戶信息TtopicidT評(píng)論話題必選followidT回復(fù)評(píng)論可選，對(duì)應(yīng)評(píng)論條目的 commentidcontentanonymousT評(píng)論內(nèi)容可選，默認(rèn)值由服務(wù)端設(shè)定T是否可選，1 為，0 為真實(shí)用戶createdby : 1,created : 1357612591, / 時(shí)間截形式的date : 32 分鐘前, / 多少秒前，友好的時(shí)間格式nickname : cmstop sus : 2,supports : 0,reports : 0,sensitive : 0, / 是否包含istop : 0,ano

13、nymous : 0,ip : ,location : LAN2.3.3 頂評(píng)論接口地址：?app=mob接受參數(shù)：ment&action=support返回?cái)?shù)據(jù)：返回字段說明：評(píng)論2.3.4向服務(wù)端想接口地址：?app=mob接受參數(shù)：ment&action=report參數(shù)方法名稱備注userauthT用戶 auth必選，用來驗(yàn)證用戶信息參數(shù)名稱備注topicid評(píng)論commentid評(píng)論supports頂次數(shù)se : true,data : topicid : 1,commentid : 1,supports : 1參數(shù)userauth方法名稱用戶 auth備注必選，用來驗(yàn)證用戶信息Tc

14、ommentidT評(píng)論必選commentidT評(píng)論必選返回?cái)?shù)據(jù)：se : true,data : topicid : 1,commentid : 1,reports : 1返回字段說明：參數(shù)名稱備注topicid評(píng)論commentid評(píng)論reports次數(shù)尺寸定義3頁面位置寬度高度備注幻燈片640314固定尺寸欄目ICO4848固定尺寸列表配圖160120固定尺寸內(nèi)容中小圖小圖只要排好版最大尺寸中大圖不大于 320不大于 480最大尺寸組圖掛件，縮略圖不大于 320不大于 480掛件，縮略圖不大于 320不大于 480列表瀑布流寬度300不限制高不限制內(nèi)容中原圖原圖最大尺寸列表配圖160120固定尺寸內(nèi)容中縮略圖580420最大尺寸4服務(wù)端配置注：尺寸，也屬于服務(wù)端配置。模塊配置值備注評(píng)論評(píng)論0/10 允許評(píng)論，1 登陸后才能評(píng)論評(píng)論是否審核0端不需要審核評(píng)論評(píng)論每頁條數(shù)10服務(wù)端固定報(bào)料報(bào)料0/10 允許報(bào)料，1 登陸后才能報(bào)料報(bào)料數(shù)量10 張報(bào)料大小2MM報(bào)料大小200MM意見反饋數(shù)量暫時(shí)不上傳天氣默認(rèn)城市weatherid每頁條