中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范

1、 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范（試行）中國電信集團(tuán)公司目 錄目 錄2前 言41適用范圍52引用標(biāo)準(zhǔn)63術(shù)語、定義和縮略語74網(wǎng)絡(luò)結(jié)構(gòu)95手機(jī)動(dòng)漫平臺(tái)與客戶端接口定義95.1接口定義約定95.2終端和平臺(tái)交互流程示例115.3業(yè)務(wù)消息體約定125.4業(yè)務(wù)消息體大小約定135.4.1消息體長度約定：135.4.2數(shù)據(jù)壓縮傳輸：135.5業(yè)務(wù)接口名稱定義135.6響應(yīng)結(jié)果碼定義155.7業(yè)務(wù)接口定義165.7.1注冊(cè)登錄接口注冊(cè)接口（register）客戶端退出接口（quit）175.7.2個(gè)性化接口綁定用戶帳戶接口（

2、adduserdata）獲取個(gè)人信息接口（getprofile）個(gè)人信息更新接口（setprofile）客戶端皮膚獲取接口（getskinpkg）205.7.3內(nèi)容信息同步接口內(nèi)容列表獲取接口（getcontentlist）內(nèi)容詳情獲取接口（getcontentdetail）內(nèi)容搜索接口（search）內(nèi)容列表節(jié)點(diǎn)（content）內(nèi)容詳細(xì)信息節(jié)點(diǎn)（contentdetail）產(chǎn)品信息節(jié)點(diǎn)（product）255.7.4訂購接口265

3、.7.4.1獲取內(nèi)容產(chǎn)品信息接口（getcontentproductinfo）2訂購內(nèi)容接口（subscribecontent）2取消訂購包月產(chǎn)品接口（unsubscribecontent）2獲取已訂購包月產(chǎn)品接口（getcatalogsubscriptionlist）2獲取按次訂購內(nèi)容列表接口（getsubscriptionlist）285.7.5在線閱讀接口2獲取漫畫分集內(nèi)容接口（getchapterinfo）2添加書簽接口（addbookmark）30刪除書簽接口（deleteb

4、ookmark）30獲取用戶書簽列表接口（getbookmark）3獲取收藏內(nèi)容列表接口（getfavorite）3添加收藏內(nèi)容接口（addfavorite）3刪除收藏內(nèi)容接口（deletefavorite）335.7.6觀看互動(dòng)接口3獲取評(píng)論接口（getcomment）3用戶評(píng)論接口（submitcomment）3用戶評(píng)分接口（markcontent）3推薦內(nèi)容接口（recommendedcontent）3獲取推薦列表接口（getrecommend）3

5、刪除推薦列表接口（deleterecommend）3獲取公告接口（getbulletin）375.8drm數(shù)字版權(quán)保護(hù)接口定義385.8.1drm數(shù)字版權(quán)保護(hù)業(yè)務(wù)流程3手機(jī)客戶端軟件激活業(yè)務(wù)流程：3許可證獲取業(yè)務(wù)流程3內(nèi)容訂購業(yè)務(wù)流程40版權(quán)重續(xù)業(yè)務(wù)流程4異常情況處理4恢復(fù)內(nèi)容業(yè)務(wù)流程435.8.2drm加密體系445.8.3手機(jī)動(dòng)漫客戶端激活接口455.8.4許可證獲取接口4產(chǎn)品許可證獲取4內(nèi)容許可證獲取4獲取產(chǎn)品許可證

6、和內(nèi)容許可證4許可證獲取失敗返回信息495.8.5http響應(yīng)碼說明495.8.6結(jié)果碼result-code說明50附錄a：ticket（許可證）50前 言本規(guī)范文檔是中國電信動(dòng)漫產(chǎn)品系列規(guī)范中的第三項(xiàng)。動(dòng)漫產(chǎn)品系列規(guī)范包括以下幾個(gè)規(guī)范：中國電信動(dòng)漫產(chǎn)品業(yè)務(wù)規(guī)范中國電信動(dòng)漫產(chǎn)品平臺(tái)技術(shù)規(guī)范中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范中國電信動(dòng)漫產(chǎn)品客戶端規(guī)范中國電信動(dòng)漫產(chǎn)品內(nèi)容保護(hù)技術(shù)規(guī)范本規(guī)范解釋權(quán)屬于中國電信集團(tuán)公司。本規(guī)范起草單位：中國電信股份有限公司上海研究院本規(guī)范主要起草人：1 適用范圍本規(guī)范定義了中國電信動(dòng)漫產(chǎn)品平臺(tái)和中國電信其他產(chǎn)品基地、電信全國it系統(tǒng)、動(dòng)漫產(chǎn)品客戶端之間進(jìn)行

7、數(shù)據(jù)通信交互的接口。適用于向中國電信提供動(dòng)漫產(chǎn)品系統(tǒng)設(shè)備的提供商，以及周邊設(shè)備和與此相關(guān)的內(nèi)容和服務(wù)提供商（cp/sp）。2 引用標(biāo)準(zhǔn)下列文件通過本文的參考而成為本規(guī)范的條款。凡是注日期的參考文件，其隨后所有的修改單（不包括勘誤的內(nèi)容）或修訂版均不適用于本文，凡是不注日期的參考文件，其最新版本適用于本文?！?】 中國電信動(dòng)漫產(chǎn)品業(yè)務(wù)規(guī)范【2】 中國電信動(dòng)漫產(chǎn)品平臺(tái)技術(shù)規(guī)范【3】 中國電信動(dòng)漫產(chǎn)品客戶端技術(shù)規(guī)范3 術(shù)語、定義和縮略語下列術(shù)語、定義和縮略語適用于本標(biāo)準(zhǔn)：名詞解釋手機(jī)客戶端安裝在手機(jī)終端上通過與動(dòng)漫產(chǎn)品平臺(tái)進(jìn)行數(shù)據(jù)交互，實(shí)現(xiàn)動(dòng)漫下載和展示的客戶端軟件。手持閱讀器/專用閱讀終端帶有無線

8、接入模塊，可連接至動(dòng)漫產(chǎn)品平臺(tái)，支持動(dòng)漫內(nèi)容的展現(xiàn)、訂購、下載和閱讀的專用手持式閱讀設(shè)備。動(dòng)漫產(chǎn)品平臺(tái)指提供動(dòng)漫產(chǎn)品核心業(yè)務(wù)能力的部分，提供動(dòng)漫的管理、下載控制、用戶管理、計(jì)費(fèi)等功能。頻道頻道是對(duì)內(nèi)容進(jìn)行的一級(jí)分類。當(dāng)用戶進(jìn)入首頁界面或者內(nèi)容導(dǎo)航界面時(shí)，看到的第一級(jí)內(nèi)容導(dǎo)航分類就是頻道。分欄分欄是內(nèi)容組織的二級(jí)分類，與其關(guān)聯(lián)的頻道有關(guān)，不同的頻道對(duì)應(yīng)著不同的分欄。每個(gè)頻道下有多個(gè)分欄，每個(gè)分欄只歸屬一個(gè)頻道。分欄可以動(dòng)態(tài)增加更多的層次。書項(xiàng)每個(gè)書項(xiàng)對(duì)應(yīng)一本動(dòng)漫作品，每個(gè)分欄下包含多個(gè)書項(xiàng)，同一個(gè)書項(xiàng)也可屬于不同的分欄。內(nèi)容項(xiàng)內(nèi)容項(xiàng)是內(nèi)容組織的最小計(jì)費(fèi)單元。每個(gè)書項(xiàng)中可包含多個(gè)內(nèi)容項(xiàng)。內(nèi)容項(xiàng)是書

9、項(xiàng)的子集。內(nèi)容項(xiàng)在計(jì)費(fèi)模式上存在試讀收費(fèi)兩種類型。漫畫以圖片、動(dòng)畫為主的動(dòng)漫作品。個(gè)人空間個(gè)人空間是指用戶個(gè)人屬性的集合，包括個(gè)人書簽、個(gè)人書架、個(gè)人批注、個(gè)人帳戶、個(gè)人設(shè)置等。個(gè)人空間同時(shí)存在于前后端，并保持更新同步。用戶書簽用戶在閱讀過程中主動(dòng)加入的書簽。系統(tǒng)書簽系統(tǒng)在用戶退出閱讀時(shí)自動(dòng)記錄的書簽。專區(qū)同一家cp/sp提供的內(nèi)容打包。防盜鏈同一個(gè)url地址只允許授權(quán)用戶下載，不允許非授權(quán)用戶直接通過url訪問。wap/web統(tǒng)一門戶中國電信動(dòng)漫業(yè)務(wù)的全國統(tǒng)一門戶，分為wap和web兩種。ceb中國電信電子書作品格式。由中國電信制定的動(dòng)漫作品格式。cpcontent provider 專業(yè)內(nèi)

10、容提供商，為平臺(tái)和用戶提供動(dòng)漫作品資源。cdmacode-divisionmultipleaccess碼分多址接入ismpinegrated service management platform綜合業(yè)務(wù)管理平臺(tái)http hyper text transfer protocol 超文本傳送協(xié)議。urluniform resource locator 統(tǒng)一資源定位。wapwireless application protocol無線應(yīng)用協(xié)議。4 網(wǎng)絡(luò)結(jié)構(gòu)動(dòng)漫平臺(tái)nsagnmsc全國cp/sp全國結(jié)算其他基地brew平臺(tái)終端自注冊(cè)平臺(tái)第三方支付平臺(tái)客戶端if1if2if3if4if5if6if7i

11、f8if9圖4-1 動(dòng)漫平臺(tái)接口圖手機(jī)動(dòng)漫平臺(tái)與其他網(wǎng)元的接口包括：1. if1：手機(jī)動(dòng)漫平臺(tái)與其他基地的接口；2. if2：手機(jī)動(dòng)漫平臺(tái)和全國cp/sp之間的接口，使用http或ftp；3. if3：手機(jī)動(dòng)漫平臺(tái)與brew平臺(tái)的接口；4. if4：手機(jī)動(dòng)漫平臺(tái)與終端自注冊(cè)平臺(tái)的接口；5. if5：手機(jī)動(dòng)漫平臺(tái)與第三方支付平臺(tái)的接口；6. if6：手機(jī)動(dòng)漫平臺(tái)與客戶端之間的接口；7. if7：手機(jī)動(dòng)漫平臺(tái)與nmsc之間的接口； 8. if8：手機(jī)動(dòng)漫平臺(tái)與isag之間的接口；9. if9：手機(jī)動(dòng)漫平臺(tái)與全國結(jié)算平臺(tái)的接口。5 手機(jī)動(dòng)漫平臺(tái)與客戶端接口定義if6接口為手機(jī)客戶端和手機(jī)動(dòng)漫平臺(tái)之間

12、的接口，客戶端通過此接口獲取用戶和內(nèi)容信息，并且完成用戶操作數(shù)據(jù)的上傳。5.1 接口定義約定手機(jī)動(dòng)漫平臺(tái)終端門戶接口消息協(xié)議棧如下圖所示：圖5-1 接口消息協(xié)議棧示意圖接口消息采用http+xml方式，終端首先同手機(jī)動(dòng)漫平臺(tái)建立會(huì)話，平臺(tái)在消息應(yīng)答中通過cookie返回會(huì)話id，客戶端在cookie中攜帶會(huì)話id繼續(xù)進(jìn)行其他接口消息交互。同時(shí)客戶端需要在http header中增加以下字段信息：必選：必須攜帶的字段；可選：指在滿足某些情況下，可以攜帶的信息，不滿足條件的情況下，可以不攜帶相關(guān)信息。請(qǐng)求消息字段名稱是否必選描述client-agent必選終端系統(tǒng)類型、終端屏幕大?。▽?高）和廠商

13、自定義信息三部分組成，三部分之間用“/”分割，如：wince5.0/240*320/otherinfomationx-up-calling-line-id必選用戶手機(jī)號(hào)碼客戶端需要通過ctwap接入點(diǎn)連接平臺(tái)，該字段由wap網(wǎng)關(guān)前傳user-id必選用戶唯一標(biāo)識(shí)，客戶端首次啟動(dòng)時(shí)通過客戶端注冊(cè)接口獲??；除客戶端注冊(cè)接口不需要該字段外，其他消息均需上報(bào)該字段信息。apiversion必選消息協(xié)議版本號(hào)，以本規(guī)范版本號(hào)定義為準(zhǔn)，如：1.0.0content-type可選消息體類型，使用post方法上傳數(shù)據(jù)時(shí)指定：application/xmlaccept-encoding可選支持的數(shù)據(jù)壓縮傳輸格式

14、，如：gzipcookie可選傳遞客戶端和平臺(tái)會(huì)話id客戶端和平臺(tái)未建立會(huì)話時(shí)，該字段不存在客戶端和平臺(tái)建立會(huì)話后，后續(xù)消息交互客戶端必須攜帶該字段參數(shù)上報(bào)會(huì)話id該字段格式要求請(qǐng)參見http/1.1 rfc2616action必選調(diào)用接口名稱平臺(tái)在應(yīng)答的http response header中包含以下字段信息：應(yīng)答消息字段名稱是否必選描述content-encoding可選如果客戶端支持壓縮傳輸，平臺(tái)返回內(nèi)容的壓縮格式result-code必選客戶端請(qǐng)求響應(yīng)結(jié)果碼，其中0表示成功，其他結(jié)果碼表示對(duì)應(yīng)的錯(cuò)誤信息content-type可選消息體類型 application/xmlconten

15、t-length可選應(yīng)答消息長度，當(dāng)平臺(tái)應(yīng)答消息包含消息體時(shí)需要指定消息體長度，不得使用chunked方式返回?cái)?shù)據(jù)。set-cookie可選如果客戶端請(qǐng)求中沒有會(huì)話id或者會(huì)話id過期時(shí)，平臺(tái)重新指定會(huì)話id該字段格式要求請(qǐng)參見http/1.1 rfc2616apiversion必選消息協(xié)議版本號(hào)，以本規(guī)范版本號(hào)定義為準(zhǔn)，如：1.0.0timestamp必選平臺(tái)當(dāng)前系統(tǒng)時(shí)間，時(shí)間格式：yyyy-mm-dd hh:mm:ss如：2008-11-08 15:14:045.2 終端和平臺(tái)交互流程示例圖5-2 終端與平臺(tái)交互流程流程說明：1. 終端啟動(dòng)時(shí)，向電信動(dòng)漫平臺(tái)發(fā)起登陸鑒權(quán)請(qǐng)求（終端首次啟動(dòng)時(shí)

16、發(fā)起注冊(cè)請(qǐng)求）；2. 電信動(dòng)漫平臺(tái)進(jìn)行終端和用戶合法性校驗(yàn)，驗(yàn)證通過后平臺(tái)生成響應(yīng)的會(huì)話信息；3. 平臺(tái)將鑒權(quán)結(jié)果（result-code字段）和會(huì)話信息（set-cookie字段）返回終端；4. 終端保存會(huì)話信息用于后續(xù)其他消息的交互；5. 終端攜帶會(huì)話信息（cookie字段）和平臺(tái)進(jìn)行其他消息的交互。5.3 業(yè)務(wù)消息體約定1、 請(qǐng)求消息和應(yīng)答消息體采用xml編碼方式，xml格式采用w3c的1.0規(guī)范，字符編碼采用utf-8。要求每個(gè)xml消息格式都是以起始。2、 消息格式采用xmlschema來定義，遵循/2001/xmlschema的國際標(biāo)準(zhǔn)。3、 請(qǐng)求消

17、息體以作為根節(jié)點(diǎn)，應(yīng)答消息體以作為根節(jié)點(diǎn)。如以下請(qǐng)求消息： v1.0.0 examplehashcode 4、 請(qǐng)求消息uri中如果包含參數(shù)需要采用utf-8編碼并經(jīng)過urlencode編碼。5、 對(duì)響應(yīng)消息的xml內(nèi)容中包含復(fù)雜信息的字段，如站內(nèi)消息內(nèi)容包含內(nèi)容的鏈接，則使用cdata語法表示，定義自定義標(biāo)簽用于標(biāo)識(shí)特殊對(duì)象，自定義特殊標(biāo)簽對(duì)象定義如下：標(biāo)簽名標(biāo)簽參數(shù)說明標(biāo)簽描述contentcontentid：內(nèi)容id內(nèi)容信息標(biāo)簽，如：西游記 第一集chaptercontentid：內(nèi)容idchapterid：章節(jié)id章節(jié)信息標(biāo)簽，如：第一章 白紙人 1 1 1234 2 false 18

18、9123456782010-03-02 12:13:14 !cdata您的好薦您一部漫畫七龍珠 5.4 業(yè)務(wù)消息體大小約定5.4.1 消息體長度約定：請(qǐng)求消息：小于4k;返回消息：小于8k;參數(shù)長度不做限定，只約定請(qǐng)求消息和返回消息的總體大??；5.4.2 數(shù)據(jù)壓縮傳輸：當(dāng)客戶端支持?jǐn)?shù)據(jù)壓縮傳輸時(shí)，需要在請(qǐng)求的消息頭的“accept-encoding”字段中指定壓縮方式（gzip），如消息可以被壓縮傳輸則平臺(tái)將應(yīng)答的數(shù)據(jù)報(bào)文進(jìn)行壓縮作為應(yīng)答數(shù)據(jù)返回，content-length為壓縮后的數(shù)據(jù)長度。詳細(xì)可參見http/1.1 rfc2616。5.

19、5 業(yè)務(wù)接口名稱定義接口名稱action定義如下：編號(hào)action接口描述客戶端登陸注冊(cè)register客戶端注冊(cè)接口quit客戶端退出接口個(gè)性化adduserdata綁定用戶帳戶接口getprofile獲取個(gè)人信息接口（包括積分，個(gè)人賬戶余額）updateprofile更新個(gè)人信息接口getskinpackage客戶端皮膚獲取接口內(nèi)容信息同步getcontentlist獲取分欄內(nèi)容列表接口getcontentdetail獲取內(nèi)容詳情接口search內(nèi)容搜索接口在線閱讀getchapterinfo獲取漫畫分集內(nèi)容接口addbookmark添加書簽接口deletebookmark刪除書簽接口ge

20、tbookmark獲取用戶書簽列表接口getfavorite獲取收藏內(nèi)容列表接口addfavorite添加收藏內(nèi)容接口deletefavorite刪除收藏內(nèi)容接口業(yè)務(wù)訂購getcontentproductinfo獲取內(nèi)容產(chǎn)品信息接口subscribecontent訂購內(nèi)容接口（包含多種訂購方式）unsubscribecatalog取消訂購包月分欄接口getsubscriptionlist獲取按次訂購內(nèi)容列表接口getcatalogsubscriptionlist獲取已訂購包月欄目接口互動(dòng)閱讀getcomment獲取評(píng)論接口submitcomment用戶評(píng)論接口markcontent用戶評(píng)分接口

21、recommendedcontent推薦內(nèi)容接口getrecommend獲取推薦列表接口deleterecommend刪除推薦接口getbulletin獲取公告接口5.6 響應(yīng)結(jié)果碼定義響應(yīng)結(jié)果碼描述0成功2001協(xié)議版本不支持2002非法的用戶標(biāo)識(shí)2003非法的客戶端2004非法的請(qǐng)求接口2005請(qǐng)求參數(shù)缺失2006無效的參數(shù)2007不支持的操作2008會(huì)話超時(shí)2009不支持的用戶信息參數(shù)2010無效的手機(jī)號(hào)碼2012無效的頻道分欄標(biāo)識(shí)2013無效的內(nèi)容標(biāo)識(shí)2014無效的排行榜類型2015無效的時(shí)間格式2016用戶未訂購2017重復(fù)的記錄2018書簽已存在2019內(nèi)容已被收藏2020更新通知

22、已預(yù)定2021更新通知未預(yù)定2022非法的用戶狀態(tài)2023業(yè)務(wù)訂購失敗2024業(yè)務(wù)取消訂購失敗2025沒有內(nèi)容的訪問權(quán)限2026驗(yàn)證碼錯(cuò)誤或者驗(yàn)證碼已過期2027用戶操作已達(dá)到每日次數(shù)限制（推薦/贈(zèng)送）2028用戶操作已達(dá)到上限（收藏/書簽）2028用戶已投票2999其他客戶端請(qǐng)求錯(cuò)誤3001請(qǐng)求超時(shí)3002服務(wù)器忙3003服務(wù)器維護(hù)中3004服務(wù)器數(shù)據(jù)庫異常3010服務(wù)器暫時(shí)不支持此功能31003199服務(wù)器自定義錯(cuò)誤碼3999其他服務(wù)器錯(cuò)誤5.7 業(yè)務(wù)接口定義5.7.1 注冊(cè)登錄接口 注冊(cè)登錄接口（register）接口描述客戶端首次啟動(dòng)，需要進(jìn)行客戶端注冊(cè)，獲取相關(guān)用戶信息

23、，以及歡迎頁。注冊(cè)成功后即自動(dòng)登錄。接口消息定義請(qǐng)求方法：get /portalapi?clientversion=xxx&clienthash=xxx&welpage參數(shù)名稱是否必選數(shù)據(jù)類型描述長度clientversion是客戶端版本clienthash是客戶端hash摘要，用于驗(yàn)證客戶端合法性clienthash=base64(md5(clientversion|客戶端內(nèi)置密碼)welpage是binary是否顯示歡迎頁請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述registerrspresponse1無actionclientinforegisterrsp0.

24、1無客戶端需要升級(jí)時(shí)包含該節(jié)點(diǎn)updateversionclientinfo1string無客戶端升級(jí)版本號(hào)updateurlclientinfo1string無客戶端升級(jí)地址mustupdateclientinfo1boolean無是否強(qiáng)制升級(jí)updatemessageclientinfo0.1string無客戶端升級(jí)加強(qiáng)特性描述信息，用于用戶提示，允許為空userinforegisterrsp0.1無用戶基本信息客戶端需要強(qiáng)制進(jìn)行版本升級(jí)時(shí)該節(jié)點(diǎn)為空useriduserinfo1string無用戶唯一標(biāo)識(shí)amountuserinfo1integer無用戶當(dāng)前余額pointuserinfo1

25、integer無用戶當(dāng)前積分nicknameuserinfo1string無昵稱homepageinforegisterrsp0.1無推送信息歡迎頁數(shù)據(jù)sysbookmarklisthomepageinfo1.n上次觀看內(nèi)容系統(tǒng)書簽bookmarkidsysbookmarklist1string無書簽idtimesysbookmarklist1書簽添加時(shí)間yymmddhhmmsschapteridsysbookmarklist1string無章節(jié)idchapternamesysbookmarklist1string無章節(jié)名稱pageidsysbookmarklist1integer無書簽頁編號(hào)

26、pushcontenthomepageinfo1content針對(duì)用戶的推薦內(nèi)容specialregisterrsp1主菜單專題欄目更新spcpicspecial1專題圖片spcnamespecial1專題名稱 客戶端退出接口（quit）接口描述客戶端退出接口接口消息定義請(qǐng)求方法：get /portalapi 請(qǐng)求消息體：參數(shù)名稱父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述quitreqrequest1actionlashbookmarkquitreq1上報(bào)用戶在線觀看漫畫的系統(tǒng)書簽typelastbookmark1integer1：系統(tǒng)書簽2：用戶書簽（此處強(qiáng)制為1）contenti

27、dlastbookmark1string內(nèi)容idpageidlastbookmark1integer頁編號(hào)響應(yīng)消息：無，通過http header的響應(yīng)結(jié)果碼返回操作結(jié)果。5.7.2 個(gè)性化接口 綁定用戶帳戶接口（adduserdata）接口描述用戶以非ctwap方式訪問動(dòng)漫平臺(tái)，客戶端發(fā)起短信注冊(cè)的同時(shí)，客戶端上報(bào)平臺(tái)用戶填寫的用戶名和密碼。接口消息定義請(qǐng)求方法：post /portalapi 請(qǐng)求消息體：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述adduserdatareqrequest1userdataadduserdatareq1usernameuserdata1st

28、ring用戶名（郵箱或其他手機(jī)號(hào)）passwrduserdata1string用戶密碼響應(yīng)消息：無，通過http header的響應(yīng)結(jié)果碼返回操作結(jié)果。 獲取個(gè)人信息接口（getprofile）接口描述獲取個(gè)人信息接口消息定義請(qǐng)求方法：get/portalapi請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述getprofilerspresponseuserinfogetprofilersp1string無用戶信息nicknameuserinfo1string無昵稱mailuserinfo個(gè)人郵箱pointuserinfo1integer無用戶積分amoun

29、tuserinfo余額 個(gè)人信息更新接口（setprofile）接口描述更新個(gè)人信息接口消息定義請(qǐng)求方法：post/portalapi請(qǐng)求消息體：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述setprofilereqrequest1userinfosetprofilereq1string用戶信息nicknameuserinfo1string昵稱mailuserinfostring個(gè)人郵箱響應(yīng)消息：無，通過http header的響應(yīng)結(jié)果碼返回操作結(jié)果。 客戶端皮膚獲取接口（getskinpkg）接口描述獲取客戶端皮膚配色方案接口消息定義請(qǐng)求方法：get /port

30、alapi請(qǐng)求消息體：無 響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述getskinpkgrspresponse1無skinpkggetskinpkgrsp1.n無皮膚配色方案borderskinpkg1rgb值邊框顏色textskinpkg1rgb值文字顏色focusskinpkg1rgb值焦點(diǎn)色buttonskinpkg1rgb值按鈕背景色listbkgndskinpkg1rgb值欄目列表背景色pictureskinpkg1背景底紋圖片descriptionskinpkg1無描述信息5.7.3 內(nèi)容信息同步接口 內(nèi)容列表獲取接口（getcontentlist）接口

31、描述獲取當(dāng)前內(nèi)容子內(nèi)容列表信息接口消息定義請(qǐng)求方法：get/portalapi?contentid=xxx& contentcount=xxx& offset=xxx參數(shù)名稱是否必選數(shù)據(jù)類型描述長度contentid 是string當(dāng)前選擇的內(nèi)容列表id 16contentcount 是integer請(qǐng)求的本內(nèi)容列表中的內(nèi)容個(gè)數(shù)，若需要全部取出則此字段寫為08offset是integer需要顯示的內(nèi)容與第一條記錄的偏移量8請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述getcontentlistrspresponse1無contentcount getcontentli

32、strsp1integer無請(qǐng)求的內(nèi)容列表中包含的內(nèi)容個(gè)數(shù)contentlistgetcontentlistrspcontent請(qǐng)求內(nèi)容列表 內(nèi)容詳情獲取接口（getcontentdetail）接口描述獲取當(dāng)前內(nèi)容的詳情接口消息定義請(qǐng)求方法：get /portalapi?contentid=xxx參數(shù)名稱是否必選數(shù)據(jù)類型描述長度contentid 是string當(dāng)前選擇的內(nèi)容列表id 16請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述getcontentdetailrspresponse1無contenttype getcontentdetailrsp1i

33、nteger無內(nèi)容contentdetailgetcontentdetailrspcontentdetail節(jié)目詳細(xì)內(nèi)容prevcontentidgetcontentdetailrspstring節(jié)目列表中前一個(gè)節(jié)目id，如是第一個(gè)，該字段為空nextcontentidgetcontentdetailrspstring節(jié)目列表中后一個(gè)節(jié)目id，如是最后一個(gè)，該字段為空productlistgetcontentdetailrspproduct可訂購的產(chǎn)品列表，包括訂購章節(jié)或者包月 內(nèi)容章節(jié)獲取接口（getchapter）接口描述獲取每個(gè)內(nèi)容id下的內(nèi)容章節(jié)列表，包括漫畫章節(jié)列表和動(dòng)

34、畫分級(jí)列表接口消息定義請(qǐng)求方法：get /portalapi?contentid=xxx&start=xxx&count=xxx參數(shù)名稱是否必選數(shù)據(jù)類型描述長度contentid 是string當(dāng)前選擇的內(nèi)容列表id 16start否integer起始頁編號(hào)count否integer需要顯示的個(gè)數(shù)缺省使用平臺(tái)默認(rèn)配置請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述getchapterrspresponse1無totalcaptergetchapterrsp0/1無當(dāng)前內(nèi)容的漫畫章節(jié)總數(shù)chapterlist getchapterrsp0/1.n無查詢到的漫畫章節(jié)列表cha

35、pteridchapterlist1無章節(jié)idseriesnumchapterlist1序號(hào)statuschapterlist1string鑒權(quán)信息表示章節(jié)的：免費(fèi)、權(quán)限及是否可以收看狀態(tài)。headurlchapterlist1無漫畫章節(jié)首地址（依格式而定）downloadurlchapterlist1無下載地址totalvideogetchapterrsp0/1無當(dāng)前內(nèi)容的動(dòng)畫章節(jié)總數(shù)videolist getchapterrsp0/1.n無查詢到的動(dòng)畫章節(jié)列表videoidvideolist1無視頻內(nèi)容idseriesnumchapterlist1序號(hào)statuschapterlist1s

36、tring鑒權(quán)信息表示章節(jié)的：免費(fèi)、權(quán)限及是否可以收看狀態(tài)。smoothurlvideoliststring流暢版播放地址cleanurlvideoliststring清晰版播放地址 內(nèi)容搜索接口（search）接口描述搜索平臺(tái)中的動(dòng)漫內(nèi)容接口消息定義請(qǐng)求方法：get /portalapi請(qǐng)求消息體：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述searchreqrequest1keywordsearchreq1string需要查詢的關(guān)鍵字searchtypesearchreq1binary查詢的內(nèi)容類型使用二進(jìn)制位描述搜索類型，“1”代表該類型有效，“0”表示該類型無效。字節(jié)位

37、檢索類型1分類檢索2動(dòng)畫3漫畫4資訊5我的動(dòng)漫searchcountsearchreq1integer需要搜索的條數(shù)，0為全部獲取offsetsearchreq1integer搜索結(jié)果中與第一條的偏移量響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述searchrspresponse1無contentlist searchrsp1content無查詢到的內(nèi)容列表contentcountsearchrspcontentdetail查詢到的內(nèi)容條數(shù)resultdescsearchrspstring結(jié)果描述 搜索熱點(diǎn)詞獲取接口（gethotword）接口描述獲取當(dāng)前搜索輸入相關(guān)

38、的熱門搜索關(guān)鍵字接口消息定義請(qǐng)求方法：get /portalapi?keyword=xxx參數(shù)名稱是否必選數(shù)據(jù)類型描述長度keyword 否string當(dāng)前輸入的搜索關(guān)鍵字 16請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述gethotwordrspresponse1無hotwordlistgethotwordrsp1string無相關(guān)熱門關(guān)鍵詞列表 內(nèi)容列表節(jié)點(diǎn)（content）參數(shù)名稱數(shù)據(jù)類型描述contentidinteger內(nèi)容idnamestring內(nèi)容名稱contenttypeinteger內(nèi)容類型1、 漫畫2、 動(dòng)畫3、 專題4、 資訊5、

39、labeltype欄目類型請(qǐng)求欄目的時(shí)候才返回1. 分類2. 連載更新3. 最新入庫4. 系統(tǒng)推薦5. 排行榜6. 相關(guān)內(nèi)容leafflaginteger是否有葉節(jié)點(diǎn)0、 沒有子內(nèi)容列表1、 有子內(nèi)容列表latesttimetime更新時(shí)間favoriateflgboolean是否已經(jīng)收藏0、 沒有收藏1、 已經(jīng)收藏subscribeflgboolean是否已經(jīng)訂購0、 沒有訂購1、 已經(jīng)訂購levelflginteger評(píng)分等級(jí)（放在此處或者詳情，跟隨ui展示）0、等級(jí)11、等級(jí)22、等級(jí)33、等級(jí)4gridpicurlstring宮格圖片地址listpicurlstring列表圖片地址de

40、scstring內(nèi)容描述clicktimesinteger被點(diǎn)擊次數(shù)contentbminteger內(nèi)容書簽 內(nèi)容詳細(xì)信息節(jié)點(diǎn)（contentdetail）contentdetail類分為動(dòng)畫類、漫畫類、產(chǎn)品類。動(dòng)畫類參數(shù)名稱參數(shù)類型說明contentidinteger內(nèi)容idparentidinteger所屬劇集idnamestring內(nèi)容名稱descriptionstring內(nèi)容簡介finishboolean該產(chǎn)品包是否完成未完成，連載已完成currentprograminteger所屬節(jié)目的級(jí)數(shù)programcountinteger所屬節(jié)目總級(jí)數(shù)，finish為0時(shí)，該字段

41、為空authorstring作者名稱gridurlstring海報(bào)地址sumittimestring發(fā)布日期(yymmdd)durationinteger節(jié)目時(shí)長（hhmmss）statusboolean是否可用，鑒權(quán)沒有權(quán)限（未曾訂購）有權(quán)限bsmoothboolean該內(nèi)容是否可用清晰版收看（drm）bclearboolean該內(nèi)容是否可用流暢版收看（drm）bdownloadboolean該內(nèi)容是否可下載（drm）recomlistcontent相關(guān)內(nèi)容推薦（熱詞、相關(guān)級(jí)數(shù)、相關(guān)內(nèi)容展示）keywordstring（1個(gè)或者多個(gè)）該級(jí)內(nèi)容關(guān)聯(lián)詞語levelflginteger評(píng)分等級(jí)（放

42、在此處或者詳情，跟隨ui展示）0、等級(jí)11、等級(jí)22、等級(jí)33、等級(jí)4clicktimeinteger該節(jié)目點(diǎn)擊次數(shù)漫畫類參數(shù)名稱參數(shù)類型說明contentidinteger內(nèi)容idparentidinteger所屬父節(jié)點(diǎn)idnamestring內(nèi)容名稱descriptionstring內(nèi)容簡介finishboolean該產(chǎn)品包是否完成0、 未完成1、 連載已完成currentprograminteger所屬節(jié)目的級(jí)數(shù)programcountinteger所屬節(jié)目總級(jí)數(shù)，finish為0時(shí)，該字段為空authorstring作者名稱gridurlstring封面圖片地址sumittimestr

43、ing發(fā)布日期(yymmdd)durationinteger節(jié)目時(shí)長（hhmmss）statusboolean是否可用，鑒權(quán)沒有權(quán)限（未曾訂購）有權(quán)限r(nóng)ecomlistcontent相關(guān)內(nèi)容推薦（熱詞、相關(guān)級(jí)數(shù)、相關(guān)內(nèi)容展示）keywordstring（1個(gè)或者多個(gè)）該級(jí)內(nèi)容關(guān)聯(lián)詞語levelflginteger評(píng)分等級(jí)（放在此處或者詳情，跟隨ui展示）0、等級(jí)11、等級(jí)22、等級(jí)33、等級(jí)4clicktimeinteger該節(jié)目點(diǎn)擊次數(shù)systembmboolean是否有系統(tǒng)書簽0、 沒有系統(tǒng)書簽1、 有系統(tǒng)書簽systembmposinteger系統(tǒng)書簽位置列表manualbmboolea

44、n是否有手動(dòng)書簽0、 沒有手動(dòng)書簽1、 有手動(dòng)書簽manualbmposinteger手動(dòng)書簽位置列表 產(chǎn)品信息節(jié)點(diǎn)（product）參數(shù)名稱數(shù)據(jù)類型描述productidinteger產(chǎn)品idproductnamestring產(chǎn)品名稱feeinteger產(chǎn)品價(jià)格purchasetypeinteger計(jì)費(fèi)類型0、免費(fèi)1、按產(chǎn)品包訂購2、 按次訂購（按照使用次數(shù)進(jìn)行計(jì)費(fèi)，無需再次訂購）3、 ppv（一次性計(jì)費(fèi)，下次使用仍然計(jì)費(fèi)）purchasetimestring產(chǎn)品購買時(shí)間yymmddhhmmssexpiretimestring產(chǎn)品過期時(shí)間yymmddhhmmssproductd

45、escstring產(chǎn)品描述levelflginteger評(píng)分等級(jí)（放在此處或者詳情，跟隨ui展示）0、等級(jí)11、等級(jí)22、等級(jí)33、等級(jí)4gridpicurlstring宮格圖片地址listpicurlstring列表圖片地址purcheastimesinteger被購買次數(shù)5.7.4 訂購接口 獲取內(nèi)容產(chǎn)品信息接口（getcontentproductinfo）接口描述客戶端獲取漫畫資源的計(jì)費(fèi)產(chǎn)品信息接口消息定義請(qǐng)求方法：get /portalapi?bookid=xxx&chapterid=xxx參數(shù)名稱是否必選數(shù)據(jù)類型描述bookid是string書idchapterid否string話id，按話計(jì)費(fèi)時(shí)必選請(qǐng)求消息體：無響應(yīng)消息：節(jié)點(diǎn)標(biāo)識(shí)父節(jié)點(diǎn)標(biāo)識(shí)出現(xiàn)次數(shù)數(shù)據(jù)類型節(jié)點(diǎn)屬性描述productinforspresponse1無產(chǎn)品信息，內(nèi)容非免費(fèi)時(shí)返回相應(yīng)的內(nèi)容資費(fèi)描述信息。返回可訂購產(chǎn)品的列表productli