中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范_第1頁
中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范_第2頁
中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范_第3頁
中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范_第4頁
中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范_第5頁
已閱讀5頁,還剩48頁未讀, 繼續(xù)免費(fèi)閱讀

付費(fèi)下載

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡介

中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 (試行) 中國電信集團(tuán)公司 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 2 目 錄 目 錄 . 2 前 言 . 4 1 適用范圍 . 5 2 引用標(biāo)準(zhǔn) . 6 3 術(shù)語、定義和縮略語 . 7 4 網(wǎng)絡(luò)結(jié)構(gòu) . 9 5 手機(jī)動(dòng)漫平臺(tái)與客戶端接口定義 . 9 5.1 接口定義約定 . 9 5.2 終端和平臺(tái)交互流程示例 .11 5.3 業(yè)務(wù)消息體約定 . 12 5.4 業(yè)務(wù)消息體大小約定 . 13 5.4.1 消息體長度約定: . 13 5.4.2 數(shù)據(jù)壓縮傳輸: . 13 5.5 業(yè)務(wù)接口名稱定義 . 13 5.6 響應(yīng)結(jié)果碼定義 . 15 5.7 業(yè)務(wù)接口定義 . 16 5.7.1 注冊(cè)登錄接口 . 16 注冊(cè)接口( register) . 16 客戶端退出接口( quit) . 18 5.7.2 個(gè)性化接口 . 18 綁定用戶帳戶接口( addUserData) . 18 獲取個(gè)人信息接口( getProfile) . 19 個(gè)人信息更新接口( setProfile) . 19 客戶端皮膚獲取接口( getSkinPkg) . 20 5.7.3 內(nèi)容信息同步接口 . 21 內(nèi)容列表獲取接口( getContentList) . 21 內(nèi)容詳情獲取接口( getContentDetail) . 21 內(nèi)容搜索接口( search) . 22 內(nèi)容列表節(jié)點(diǎn)( Content) . 24 內(nèi)容詳細(xì)信息節(jié)點(diǎn)( ContentDetail) . 26 產(chǎn)品信息節(jié)點(diǎn)( product) . 28 5.7.4 訂購接口 . 28 獲取內(nèi)容產(chǎn)品信息接口( getContentProductInfo) . 28 訂購內(nèi)容接口( subscribeContent) . 29 取消訂購包月產(chǎn)品接口( unsubscribeContent) . 29 獲取已訂購包月產(chǎn)品接口( getCatalogSubscriptionList) . 30 獲取按次訂購內(nèi)容列表接口( getSubscriptionList) . 31 5.7.5 在線閱讀接口 . 32 獲取漫畫分集內(nèi)容接口( getChapterInfo) . 32 添加書簽接口( addBookmark) . 32 刪除書簽接口( deleteBookmark) . 33 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 3 獲取用戶書簽列表接口( getBookmark) . 33 獲取收藏內(nèi)容列表接口( getFavorite) . 35 添加收藏內(nèi)容接口( addFavorite) . 35 刪除收藏內(nèi)容接口( deleteFavorite) . 36 5.7.6 觀看互動(dòng)接口 . 36 獲取評(píng)論接口( getComment) . 36 用戶評(píng)論接口( submitComment) . 37 用戶評(píng)分接口( markContent) . 38 推薦內(nèi)容接口( recommendedContent) . 38 獲取推薦列表接口( getRecommend) . 39 刪除推薦列表接口( deleteRecommend) . 39 獲取公告接口( getBulletin) . 40 5.8 DRM 數(shù)字版權(quán)保護(hù)接口定義 . 41 5.8.1 DRM 數(shù)字版權(quán)保護(hù)業(yè)務(wù)流程 . 41 手機(jī)客戶端軟件激活業(yè)務(wù)流程: . 41 許可證獲取業(yè)務(wù)流程 . 42 內(nèi)容訂購業(yè)務(wù)流程 . 42 版權(quán)重續(xù)業(yè)務(wù)流程 . 43 異常情況處理 . 44 恢復(fù)內(nèi)容業(yè)務(wù)流程 . 45 5.8.2 DRM 加密體系 . 46 5.8.3 手機(jī)動(dòng)漫客戶端激活接口 . 47 5.8.4 許可證獲取接口 . 48 產(chǎn)品許可證獲取 . 48 內(nèi)容許可證獲取 . 49 獲取產(chǎn)品許可證和內(nèi)容許可證 . 50 許可證獲取失敗返回信息 . 51 5.8.5 HTTP 響應(yīng)碼說明 . 51 5.8.6 結(jié)果碼 result-code 說明 . 52 附錄 A: Ticket(許可證) . 52 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 4 前 言 本規(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ī)范主要起草人: 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 5 1 適用范圍 本規(guī)范定義了中國電信動(dòng)漫產(chǎn)品平臺(tái)和中國電信其他產(chǎn)品基地、電信全國 IT 系統(tǒng)、動(dòng)漫產(chǎn)品客戶端之間進(jìn)行數(shù)據(jù)通信交互的接口。適用于向中國電信提供動(dòng)漫產(chǎn)品系統(tǒng) 設(shè)備的提供商,以及周邊設(shè)備和與此相關(guān)的內(nèi)容和服務(wù)提供商( CP/SP)。 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 6 2 引用標(biāo)準(zhǔn) 下列文件通過本文的參考而成為本規(guī)范的條款。凡是注日期的參考文件,其隨后所有的修改單(不包括勘誤的內(nèi)容)或修訂版均不適用于本文,凡是不注日期的參考文件,其最新版本適用于本文。 【 1】 中國電信動(dòng)漫產(chǎn)品業(yè)務(wù)規(guī)范 【 2】 中國電信動(dòng)漫產(chǎn)品平臺(tái)技術(shù)規(guī)范 【 3】 中國電信動(dòng)漫產(chǎn)品客戶端技術(shù)規(guī)范 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 7 3 術(shù)語、定義和縮略語 下列術(shù)語、定義和縮略語適用于本標(biāo)準(zhǔn): 名詞 解釋 手機(jī)客戶端 安裝在手機(jī)終端上通過與動(dòng)漫產(chǎn)品平臺(tái)進(jìn)行數(shù)據(jù)交互,實(shí)現(xiàn)動(dòng)漫下載和展示的客戶端軟 件。 手持閱讀器 /專用閱讀終端 帶有無線接入模塊,可連接至動(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)是書項(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訪問。 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 8 WAP/WEB 統(tǒng)一門戶 中國電信動(dòng)漫業(yè)務(wù)的全國統(tǒng)一門戶,分為 WAP 和 WEB 兩種。 CEB 中國電信電子書作品格式。由中國電信制定的動(dòng)漫作品格式。 CP Content Provider 專業(yè)內(nèi)容提供商,為平臺(tái)和用戶提供動(dòng)漫作品資源。 CDMA Code-DivisionMultipleAccess 碼分多址接入 ISMP Inegrated Service Management Platform 綜 合業(yè)務(wù)管理平臺(tái) HTTP Hyper Text Transfer Protocol 超文本傳送協(xié)議。 URL Uniform Resource Locator 統(tǒng)一資源定位。 WAP Wireless Application Protocol 無線應(yīng)用協(xié)議。 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 9 4 網(wǎng)絡(luò)結(jié)構(gòu) 圖 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)之間的接口,客戶端通過此接口獲取用戶和內(nèi)容信息,并且完成用戶操作數(shù)據(jù)的上傳。 5.1 接口定義約定 手機(jī)動(dòng)漫平臺(tái)終端門戶接口消息協(xié)議棧 如下圖所示: 動(dòng)漫平臺(tái) NSAG NMSC 全國 CP / SP 全國結(jié)算 其他基地 Brew 平臺(tái) 終端自注冊(cè)平臺(tái) 第三方支付平臺(tái) 客戶端 IF 1 IF 2 IF 3 IF 4 IF 5 IF 6 IF 7 IF 8 IF 9 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 10 TCP/IP底 層 承 載HTTP會(huì) 話 層業(yè) 務(wù) 消 息圖 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) 類型、終端屏幕大小(寬 *高)和廠商自定義信息三部分組成,三部分之間用“ /”分割,如: WINCE5.0/240*320/OtherInfomation x-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.0 Content-Type 可選 消息體類型,使用 POST 方法上傳數(shù)據(jù)時(shí)指定: application/xml Accept-Encoding 可選 支持的數(shù)據(jù)壓縮傳輸格式,如: gzip Cookie 可選 傳遞客戶端和平臺(tái)會(huì)話 ID 客戶端和平臺(tái)未建立會(huì)話時(shí),該字段不存在 客戶端和平臺(tái)建立會(huì)話后,后續(xù)消息交互客戶端必須攜帶該字段參數(shù)上報(bào)會(huì)話 ID 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 11 該字段格式要求請(qǐng)參見 HTTP/1.1 RFC2616 Action 必選 調(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/xml Content-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 RFC2616 APIVersion 必選 消息協(xié)議版本號(hào),以本規(guī)范版本號(hào)定義為準(zhǔn),如: 1.0.0 TimeStamp 必選 平臺(tái)當(dāng)前系統(tǒng)時(shí)間,時(shí)間格式: yyyy-MM-dd HH:mm:ss 如: 2008-11-08 15:14:04 5.2 終端和平臺(tái)交互流程示例 終 端 電 信 動(dòng) 漫 平 臺(tái)終 端 登 陸 鑒 權(quán) 請(qǐng) 求鑒 權(quán) 通 過 并 產(chǎn) 生 會(huì) 話鑒 權(quán) 請(qǐng) 求 響 應(yīng)終 端 保 存 會(huì) 話 信 息終 端 攜 帶 會(huì) 話 信 息 請(qǐng) 求 其 他 消 息其 他 消 息 應(yīng) 答圖 5-2 終端與平臺(tái)交互流程 流程說明: 1. 終端啟動(dòng)時(shí),向電信動(dòng)漫平臺(tái)發(fā)起登陸鑒權(quán)請(qǐng)求 (終端首次啟動(dòng)時(shí)發(fā)起注冊(cè)請(qǐng)求); 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 12 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)求消息體以 作為根節(jié)點(diǎn),應(yīng)答消息體以 作為根節(jié)點(diǎn)。如以下請(qǐng)求消息: 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)簽描述 content contentid:內(nèi)容 ID 內(nèi)容信息標(biāo)簽,如: 西游記 第一集 chapter contentid:內(nèi)容 ID chapterid:章節(jié) ID 章節(jié)信息標(biāo)簽,如: 第一章 白紙人 V1.0.0 examplehashcode 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 13 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.5 業(yè)務(wù)接口名稱定義 接口名稱 Action 定義如下: 1 1 1234 2 false18912345678 2010-03-02 12:13:14 七龍珠 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 14 編號(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 刪除書簽接口 getBookmark 獲取用戶書簽列表接口 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)論接口 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 15 markContent 用戶評(píng)分接口 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 更新通知已預(yù)定 2021 更新通知未預(yù)定 2022 非法的用戶狀態(tài) 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 16 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)用戶信息 ,以及歡迎頁 。注冊(cè)成功后即自動(dòng)登錄。 接口消息定義 請(qǐng)求方法: GET /portalapi?clientVersion=xxx&clientHash=xxx&welPage 參數(shù) 名稱 是否必選 數(shù)據(jù)類型 描述 長度 clientVersion 是 客戶端版本 clientHash 是 客戶端 Hash 摘要,用于驗(yàn)證客戶端合法性 ClientHash=Base64(MD5(ClientVersion|客戶端 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 17 內(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)屬性 描述 RegisterRsp Response 1 無 Action ClientInfo RegisterRsp 0.1 無 客戶端需要升級(jí)時(shí)包含該節(jié)點(diǎn) updateVersion ClientInfo 1 String 無 客戶端升級(jí)版本號(hào) updateURL ClientInfo 1 String 無 客戶端升級(jí)地址 mustUpdate ClientInfo 1 Boolean 無 是否強(qiáng)制升級(jí) updateMessage ClientInfo 0.1 String 無 客戶端升級(jí)加強(qiáng)特性描述信息,用于用戶提示,允許為空 UserInfo RegisterRsp 0.1 無 用戶基本信息 客戶端需要強(qiáng)制進(jìn)行版本升級(jí)時(shí)該節(jié)點(diǎn)為空 userID UserInfo 1 String 無 用戶唯一標(biāo)識(shí) amount UserInfo 1 Integer 無 用戶當(dāng)前余額 point UserInfo 1 Integer 無 用戶當(dāng)前積分 nickName UserInfo 1 string 無 昵稱 homepageInfo RegisterRsp 0.1 無 推送信息 歡迎頁數(shù)據(jù) sysBookmarkList homepageInfo 1.n 上次觀看內(nèi)容系統(tǒng)書簽 bookmarkId sysBookmarkList 1 String 無 書簽 ID Time sysBookmarkList 1 書簽添加時(shí)間 yymmddhhmmss chapterId sysBookmarkList 1 String 無 章節(jié) ID chapterName sysBookmarkList 1 String 無 章節(jié)名稱 pageId sysBookmarkList 1 Integer 無 書簽頁編號(hào) pushContent homepageInfo 1 Content 針 對(duì)用戶的推薦內(nèi)容 Special RegisterRsp 1 主菜單專題欄目更新 spcPic Special 1 專題圖片 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 18 spcName Special 1 專題名稱 客戶端退出接口( quit) 接口描述 客戶端退出接口 接口消息定義 請(qǐng)求方法: GET /portalapi 請(qǐng)求消息體: 參數(shù)名稱 父節(jié)點(diǎn)標(biāo)識(shí) 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點(diǎn)屬性 描述 quitReq Request 1 Action lashBookmark quitReq 1 上報(bào)用戶在線觀看漫畫的系 統(tǒng)書簽 type lastBookmark 1 Integer 1:系統(tǒng)書簽 2:用戶書簽 (此處強(qiáng)制為 1) contentId lastBookmark 1 String 內(nèi)容 id pageId lastBookmark 1 Integer 頁編號(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)求消息體: 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 19 節(jié)點(diǎn)標(biāo)識(shí) 父節(jié)點(diǎn)標(biāo)識(shí) 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點(diǎn)屬性 描述 AddUserDataReq Request 1 userData AddUserDataReq 1 userName userData 1 String 用戶名(郵箱或其他手機(jī)號(hào)) passWrd userData 1 String 用戶密碼 響應(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)屬性 描述 getProfileRsp Response UserInfo getProfileRsp 1 string 無 用戶信息 nickName UserInfo 1 string 無 昵稱 Mail UserInfo 個(gè)人郵箱 point UserInfo 1 Integer 無 用戶積分 amount UserInfo 余額 個(gè)人信息更新接口 ( setProfile) 接口描述 更新 個(gè)人信息 接口消息定義 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 20 請(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)屬性 描述 setProfileReq Request 1 UserInfo setProfileReq 1 string 用戶信息 nickName UserInfo 1 string 昵稱 Mail UserInfo string 個(gè)人郵箱 響應(yīng)消息: 無,通過 HTTP header 的響應(yīng)結(jié)果碼返回操作結(jié)果。 客戶端皮膚獲取接口( getSkinPkg) 接口描述 獲取 客戶端 皮膚配色方案 接口消息定義 請(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)屬性 描述 GetSkinPkgRsp Response 1 無 skinPkg GetSkinPkgRsp 1.n 無 皮膚配色方案 border skinPkg 1 Rgb 值 邊框 顏色 text skinPkg 1 Rgb 值 文 字 顏色 focus skinPkg 1 Rgb 值 焦點(diǎn) 色 button skinPkg 1 Rgb 值 按鈕 背景色 listBkgnd skinPkg 1 Rgb 值 欄目列表 背景色 picture skinPkg 1 背景底紋圖片 description skinPkg 1 無 描述信息 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 21 5.7.3 內(nèi)容信息同步 接口 內(nèi)容列表獲取接口 ( getContentList) 接口描述 獲取當(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 16 ContentCount 是 Integer 請(qǐng)求的本內(nèi)容列表中的內(nèi)容個(gè)數(shù),若需要全部取出則此字段寫為 0 8 Offset 是 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)屬性 描述 GetContentListRsp Response 1 無 ContentCount GetContentListRsp 1 Integer 無 請(qǐng)求的內(nèi)容列表中包含的內(nèi)容個(gè)數(shù) ContentList GetContentListRsp Content 請(qǐng)求內(nèi)容列表 內(nèi)容詳情獲取接口 ( getContentDetail) 接口描述 獲取當(dāng)前內(nèi)容的詳情 接口消息定義 請(qǐng)求方法: GET /portalapi?ContentID=xxx 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 22 參數(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)屬性 描述 GetContentDetailRsp Response 1 無 ContentType GetContentDetailRsp 1 Integer 無 內(nèi)容 ContentDetail GetContentDetailRsp ContentDetail 節(jié)目詳細(xì)內(nèi)容 PrevContentID GetContentDetailRsp String 節(jié)目列表中前一個(gè)節(jié)目 ID,如是第一個(gè) ,該字段為空 NextContentID GetContentDetailRsp String 節(jié)目列表中后一個(gè)節(jié)目 ID,如是最后一個(gè),該字段為空 ProductList GetContentDetailRsp Product 可訂購的產(chǎn)品列表,包括訂購章節(jié)或者包月 內(nèi)容章節(jié)獲取接口 ( getChapter) 接口描述 獲取每個(gè)內(nèi)容 ID 下的 內(nèi)容章節(jié)列表,包括漫畫章節(jié)列表和動(dòng)畫分級(jí)列表 接口消息定義 請(qǐng)求方法: GET /portalapi?ContentID=xxx&start=xxx&count=xxx 參數(shù)名稱 是否必選 數(shù)據(jù)類型 描述 長度 ContentID 是 String 當(dāng)前選擇的內(nèi)容列表 ID 16 start 否 Integer 起始頁編號(hào) count 否 Integer 需要顯示的個(gè)數(shù) 缺省使用平臺(tái)默認(rèn)配置 中國電信動(dòng)漫產(chǎn)品平臺(tái)接口規(guī)范 23 請(qǐng)求消息體: 無 響應(yīng)消息: 節(jié)點(diǎn)標(biāo)識(shí) 父節(jié)點(diǎn)標(biāo)識(shí) 出現(xiàn)次數(shù)

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論