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

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權,請進行舉報或認領

文檔簡介

中國電信動漫產(chǎn)品平臺接口規(guī)范 (試行) 中國電信集團公司 中國電信動漫產(chǎn)品平臺接口規(guī)范 2 目 錄 目 錄 . 2 前 言 . 4 1 適用范圍 . 5 2 引用標準 . 6 3 術語、定義和縮略語 . 7 4 網(wǎng)絡結構 . 9 5 手機動漫平臺與客戶端接口定義 . 9 5.1 接口定義約定 . 9 5.2 終端和平臺交互流程示例 .11 5.3 業(yè)務消息體約定 . 12 5.4 業(yè)務消息體大小約定 . 13 5.4.1 消息體長度約定: . 13 5.4.2 數(shù)據(jù)壓縮傳輸: . 13 5.5 業(yè)務接口名稱定義 . 13 5.6 響應結果碼定義 . 15 5.7 業(yè)務接口定義 . 16 5.7.1 注冊登錄接口 . 16 注冊接口( register) . 16 客戶端退出接口( quit) . 18 5.7.2 個性化接口 . 18 綁定用戶帳戶接口( addUserData) . 18 獲取個人信息接口( getProfile) . 19 個人信息更新接口( 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é)點( Content) . 24 內(nèi)容詳細信息節(jié)點( ContentDetail) . 26 產(chǎn)品信息節(jié)點( 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 中國電信動漫產(chǎn)品平臺接口規(guī)范 3 獲取用戶書簽列表接口( getBookmark) . 33 獲取收藏內(nèi)容列表接口( getFavorite) . 35 添加收藏內(nèi)容接口( addFavorite) . 35 刪除收藏內(nèi)容接口( deleteFavorite) . 36 5.7.6 觀看互動接口 . 36 獲取評論接口( getComment) . 36 用戶評論接口( submitComment) . 37 用戶評分接口( markContent) . 38 推薦內(nèi)容接口( recommendedContent) . 38 獲取推薦列表接口( getRecommend) . 39 刪除推薦列表接口( deleteRecommend) . 39 獲取公告接口( getBulletin) . 40 5.8 DRM 數(shù)字版權保護接口定義 . 41 5.8.1 DRM 數(shù)字版權保護業(yè)務流程 . 41 手機客戶端軟件激活業(yè)務流程: . 41 許可證獲取業(yè)務流程 . 42 內(nèi)容訂購業(yè)務流程 . 42 版權重續(xù)業(yè)務流程 . 43 異常情況處理 . 44 恢復內(nèi)容業(yè)務流程 . 45 5.8.2 DRM 加密體系 . 46 5.8.3 手機動漫客戶端激活接口 . 47 5.8.4 許可證獲取接口 . 48 產(chǎn)品許可證獲取 . 48 內(nèi)容許可證獲取 . 49 獲取產(chǎn)品許可證和內(nèi)容許可證 . 50 許可證獲取失敗返回信息 . 51 5.8.5 HTTP 響應碼說明 . 51 5.8.6 結果碼 result-code 說明 . 52 附錄 A: Ticket(許可證) . 52 中國電信動漫產(chǎn)品平臺接口規(guī)范 4 前 言 本規(guī)范文檔是 中國電信 動漫產(chǎn)品系列規(guī)范中的第三項。 動漫產(chǎn)品系列規(guī)范包括以下幾個規(guī)范: 中國電信動漫產(chǎn)品業(yè)務規(guī)范 中國電信動漫產(chǎn)品平臺技術規(guī)范 中國電信動漫產(chǎn)品平臺接口規(guī)范 中國電信動漫產(chǎn)品客戶端規(guī)范 中國電信動漫產(chǎn)品內(nèi)容保護技術規(guī)范 本規(guī)范解釋權屬于中國電信集團公司。 本規(guī)范起草單位:中國電信股份有限公司上海研究院 本規(guī)范主要起草人: 中國電信動漫產(chǎn)品平臺接口規(guī)范 5 1 適用范圍 本規(guī)范定義了中國電信動漫產(chǎn)品平臺和中國電信其他產(chǎn)品基地、電信全國 IT 系統(tǒng)、動漫產(chǎn)品客戶端之間進行數(shù)據(jù)通信交互的接口。適用于向中國電信提供動漫產(chǎn)品系統(tǒng) 設備的提供商,以及周邊設備和與此相關的內(nèi)容和服務提供商( CP/SP)。 中國電信動漫產(chǎn)品平臺接口規(guī)范 6 2 引用標準 下列文件通過本文的參考而成為本規(guī)范的條款。凡是注日期的參考文件,其隨后所有的修改單(不包括勘誤的內(nèi)容)或修訂版均不適用于本文,凡是不注日期的參考文件,其最新版本適用于本文。 【 1】 中國電信動漫產(chǎn)品業(yè)務規(guī)范 【 2】 中國電信動漫產(chǎn)品平臺技術規(guī)范 【 3】 中國電信動漫產(chǎn)品客戶端技術規(guī)范 中國電信動漫產(chǎn)品平臺接口規(guī)范 7 3 術語、定義和縮略語 下列術語、定義和縮略語適用于本標準: 名詞 解釋 手機客戶端 安裝在手機終端上通過與動漫產(chǎn)品平臺進行數(shù)據(jù)交互,實現(xiàn)動漫下載和展示的客戶端軟 件。 手持閱讀器 /專用閱讀終端 帶有無線接入模塊,可連接至動漫產(chǎn)品平臺,支持動漫內(nèi)容的展現(xiàn)、訂購、下載和閱讀的專用手持式閱讀設備。 動漫產(chǎn)品平臺 指提供動漫產(chǎn)品核心業(yè)務能力的部分,提供動漫的管理、下載控制、用戶管理、計費等功能。 頻道 頻道是對內(nèi)容進行的一級分類。當用戶進入首頁界面或者內(nèi)容導航界面時,看到的第一級內(nèi)容導航分類就是頻道。 分欄 分欄是內(nèi)容組織的二級分類,與其關聯(lián)的頻道有關,不同的頻道對應著不同的分欄。每個頻道下有多個分欄,每個分欄只歸屬一個頻道。分欄可以動態(tài)增加更多的層次。 書項 每 個書項對應一本動漫作品,每個分欄下包含多個書項,同一個書項也可屬于不同的分欄。 內(nèi)容項 內(nèi)容項是內(nèi)容組織的最小計費單元。每個書項中可包含多個內(nèi)容項。內(nèi)容項是書項的子集。內(nèi)容項在計費模式上存在試讀收費兩種類型。 漫畫 以圖片、動畫為主的動漫作品。 個人空間 個人空間是指用戶個人屬性的集合,包括個人書簽、個人書架、個人批注、個人帳戶、個人設置等。個人空間同時存在于前后端,并保持更新同步。 用戶書簽 用戶在閱讀過程中主動加入的書簽。 系統(tǒng)書簽 系統(tǒng)在用戶退出閱讀時自動記錄的書簽。 專區(qū) 同一家 CP/SP 提供的內(nèi)容打包。 防盜鏈 同一個 URL地址只允許授權用戶下載,不允許非授權用戶直接通過 URL訪問。 中國電信動漫產(chǎn)品平臺接口規(guī)范 8 WAP/WEB 統(tǒng)一門戶 中國電信動漫業(yè)務的全國統(tǒng)一門戶,分為 WAP 和 WEB 兩種。 CEB 中國電信電子書作品格式。由中國電信制定的動漫作品格式。 CP Content Provider 專業(yè)內(nèi)容提供商,為平臺和用戶提供動漫作品資源。 CDMA Code-DivisionMultipleAccess 碼分多址接入 ISMP Inegrated Service Management Platform 綜 合業(yè)務管理平臺 HTTP Hyper Text Transfer Protocol 超文本傳送協(xié)議。 URL Uniform Resource Locator 統(tǒng)一資源定位。 WAP Wireless Application Protocol 無線應用協(xié)議。 中國電信動漫產(chǎn)品平臺接口規(guī)范 9 4 網(wǎng)絡結構 圖 4-1 動漫平臺接口圖 手機動漫平臺與其他網(wǎng)元的接口包括: 1. IF1:手機動漫平臺與其他基地的接口; 2. IF2:手機動漫平臺和全國 CP/SP之間的接口,使用 HTTP或 FTP; 3. IF3:手機動漫平臺與 Brew平臺的接口; 4. IF4:手機動漫平臺與終端自注冊平臺的接口; 5. IF5:手機動漫平臺與第三方支付平臺的接口; 6. IF6:手機動漫平臺與客戶端之間的接口; 7. IF7:手機動漫平臺與 NMSC之間的接口; 8. IF8:手機動漫平臺與 ISAG之間的接口; 9. IF9:手機動漫平臺與全國結算平臺的接口。 5 手機動漫平臺與客戶端接口定義 IF6 接口為手機客戶端和手機動漫平臺之間的接口,客戶端通過此接口獲取用戶和內(nèi)容信息,并且完成用戶操作數(shù)據(jù)的上傳。 5.1 接口定義約定 手機動漫平臺終端門戶接口消息協(xié)議棧 如下圖所示: 動漫平臺 NSAG NMSC 全國 CP / SP 全國結算 其他基地 Brew 平臺 終端自注冊平臺 第三方支付平臺 客戶端 IF 1 IF 2 IF 3 IF 4 IF 5 IF 6 IF 7 IF 8 IF 9 中國電信動漫產(chǎn)品平臺接口規(guī)范 10 TCP/IP底 層 承 載HTTP會 話 層業(yè) 務 消 息圖 5-1 接口消息協(xié)議棧示意圖 接口消息采用 HTTP+XML 方式,終端首先同手機動漫平臺建立會話,平臺在消息應答中通過 Cookie 返回會話 ID,客戶端在 Cookie 中攜帶會話 ID 繼續(xù)進行其他接口消息交互。 同時客戶端需要在 HTTP Header 中增加以下字段信息: 必選:必須攜帶的字段; 可選:指在滿足某些情況下,可以攜帶的信息,不滿足條件的情況下,可以不攜帶相關信息。 請求消息 字段名稱 是否必選 描述 Client-Agent 必選 終端 系統(tǒng) 類型、終端屏幕大?。▽?*高)和廠商自定義信息三部分組成,三部分之間用“ /”分割,如: WINCE5.0/240*320/OtherInfomation x-up-calling-line-id 必選 用戶手機號碼 客戶端需要通過 ctwap 接入點連接平臺,該字段由 WAP 網(wǎng)關前傳 user-id 必選 用戶唯一標識,客戶端首次啟動時通過客戶端注冊接口獲取; 除客戶端注冊接口不需要該字段外,其他消息均需上報該字段信息。 APIVersion 必選 消息協(xié)議版本號,以本規(guī)范版本號定義為 準,如:1.0.0 Content-Type 可選 消息體類型,使用 POST 方法上傳數(shù)據(jù)時指定: application/xml Accept-Encoding 可選 支持的數(shù)據(jù)壓縮傳輸格式,如: gzip Cookie 可選 傳遞客戶端和平臺會話 ID 客戶端和平臺未建立會話時,該字段不存在 客戶端和平臺建立會話后,后續(xù)消息交互客戶端必須攜帶該字段參數(shù)上報會話 ID 中國電信動漫產(chǎn)品平臺接口規(guī)范 11 該字段格式要求請參見 HTTP/1.1 RFC2616 Action 必選 調(diào)用接口名稱 平臺在應答的 HTTP Response Header 中包含以下字段信息: 應答消息 字段名稱 是否必選 描述 Content-Encoding 可選 如果客戶端支持壓縮傳輸,平臺返回內(nèi)容的壓縮格式 result-code 必選 客戶端請求響應結果碼,其中 0 表示成功,其他結果碼表示對應的錯誤信息 Content-Type 可選 消息體類型 application/xml Content-Length 可選 應答消息長度,當平臺應答消息包含消息體時需要指定消息體長度,不得使用 chunked 方式返回數(shù)據(jù)。 Set-Cookie 可選 如果客戶端 請求中沒有會話 ID 或者會話 ID 過期時,平臺重新指定會話 ID 該字段格式要求請參見 HTTP/1.1 RFC2616 APIVersion 必選 消息協(xié)議版本號,以本規(guī)范版本號定義為準,如: 1.0.0 TimeStamp 必選 平臺當前系統(tǒng)時間,時間格式: yyyy-MM-dd HH:mm:ss 如: 2008-11-08 15:14:04 5.2 終端和平臺交互流程示例 終 端 電 信 動 漫 平 臺終 端 登 陸 鑒 權 請 求鑒 權 通 過 并 產(chǎn) 生 會 話鑒 權 請 求 響 應終 端 保 存 會 話 信 息終 端 攜 帶 會 話 信 息 請 求 其 他 消 息其 他 消 息 應 答圖 5-2 終端與平臺交互流程 流程說明: 1. 終端啟動時,向電信動漫平臺發(fā)起登陸鑒權請求 (終端首次啟動時發(fā)起注冊請求); 中國電信動漫產(chǎn)品平臺接口規(guī)范 12 2. 電信動漫平臺進行終端和用戶合法性校驗,驗證通過后平臺生成響應的會話信息; 3. 平臺將鑒權結果( result-code 字段)和會話信息( set-cookie 字段)返回終端; 4. 終端保存會話信息用于后續(xù)其他消息的交互; 5. 終端攜帶會話信息( cookie 字段)和平臺進行其他消息的交互。 5.3 業(yè)務消息體約定 1、 請求消息和應答消息體采用 XML 編碼方式, XML 格式采用 W3C 的 1.0 規(guī)范,字符編碼采用 UTF-8。要求每個 XML 消息格式都是以 起始。 2、 消息格式采用 XMLSchema 來定義,遵循 /2001/XMLSchema 的國際標準。 3、 請求消息體以 作為根節(jié)點,應答消息體以 作為根節(jié)點。如以下請求消息: 4、 請求消息 URI 中如果包含參數(shù)需要采用 UTF-8 編碼并經(jīng)過 URLEncode 編碼。 5、 對響應消息的 XML 內(nèi)容中 包含復雜信息的字段,如站內(nèi)消息內(nèi)容包含內(nèi)容的鏈接,則使用 CDATA 語法表示,定義自定義標簽用于標識特殊對象,自定義特殊標簽對象定義如下: 標簽名 標簽參數(shù)說明 標簽描述 content contentid:內(nèi)容 ID 內(nèi)容信息標簽,如: 西游記 第一集 chapter contentid:內(nèi)容 ID chapterid:章節(jié) ID 章節(jié)信息標簽,如: 第一章 白紙人 V1.0.0 examplehashcode 中國電信動漫產(chǎn)品平臺接口規(guī)范 13 5.4 業(yè)務消息體大小約定 5.4.1 消息體長度約定: 請求消息:小于 4K; 返回消息:小于 8K; 參數(shù)長度不做限定,只約定請求消息和返回消息的總體大?。?5.4.2 數(shù)據(jù)壓縮傳輸: 當客戶端支持數(shù)據(jù)壓縮傳輸時,需要在請求的消息頭的“ Accept-Encoding”字段中指定壓縮方式( gzip),如消息可以被壓縮傳輸則平臺將應答的數(shù)據(jù)報文進行壓縮作為應答數(shù)據(jù)返回, Content-Length 為壓縮后的數(shù)據(jù)長度。詳細可參見 HTTP/1.1 RFC2616。 5.5 業(yè)務接口名稱定義 接口名稱 Action 定義如下: 1 1 1234 2 false18912345678 2010-03-02 12:13:14 七龍珠 中國電信動漫產(chǎn)品平臺接口規(guī)范 14 編號 Action 接口描述 客戶端登陸注冊 register 客戶端注冊接口 quit 客戶端退出接口 個性化 addUserData 綁定用戶帳戶接口 getProfile 獲取個人信息接口(包括積分,個人賬戶余 額) updateProfile 更新個人信息接口 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è)務訂購 getContentProductInfo 獲取內(nèi)容產(chǎn)品信息接 口 subscribeContent 訂購內(nèi)容接口( 包含多種訂購方式 ) unsubscribeCatalog 取消訂購包月分欄接口 getSubscriptionList 獲取按次訂購內(nèi)容列表接口 getCatalogSubscriptionList 獲取已訂購包月欄目接口 互動閱讀 getComment 獲取評論接口 submitComment 用戶評論接口 中國電信動漫產(chǎn)品平臺接口規(guī)范 15 markContent 用戶評分接口 recommendedContent 推薦內(nèi)容接口 getRecommend 獲取推薦列表接口 deleteRecommend 刪除推薦接口 getBulletin 獲取公告接口 5.6 響應結果碼定義 響應結果碼 描述 0 成功 2001 協(xié)議版本不支持 2002 非法的用戶標識 2003 非法的客戶端 2004 非法的請求接口 2005 請求參數(shù)缺失 2006 無效的參數(shù) 2007 不支持的操作 2008 會話超時 2009 不支持的用戶信息參數(shù) 2010 無效的手機號碼 2012 無效的頻道分欄標識 2013 無效的內(nèi)容標識 2014 無效 的排行榜類型 2015 無效的時間格式 2016 用戶未訂購 2017 重復的記錄 2018 書簽已存在 2019 內(nèi)容已被收藏 2020 更新通知已預定 2021 更新通知未預定 2022 非法的用戶狀態(tài) 中國電信動漫產(chǎn)品平臺接口規(guī)范 16 2023 業(yè)務訂購失敗 2024 業(yè)務取消訂購失敗 2025 沒有內(nèi)容的訪問權限 2026 驗證碼錯誤或者驗證碼已過期 2027 用戶操作已達到每日次數(shù)限制(推薦 /贈送) 2028 用戶操作已達到上限(收藏 /書簽) 2028 用戶已投票 2999 其他客戶端請求錯誤 3001 請求超時 3002 服務器忙 3003 服務器維護中 3004 服務器數(shù)據(jù)庫異常 3010 服務器暫時不支持此功能 31003199 服務器自定義錯誤碼 3999 其他服務器錯誤 5.7 業(yè)務接口定義 5.7.1 注冊 登錄接口 注冊 登錄 接口( register) 接口描述 客戶端首次啟動,需要進行客戶端注冊,獲取相關用戶信息 ,以及歡迎頁 。注冊成功后即自動登錄。 接口消息定義 請求方法: GET /portalapi?clientVersion=xxx&clientHash=xxx&welPage 參數(shù) 名稱 是否必選 數(shù)據(jù)類型 描述 長度 clientVersion 是 客戶端版本 clientHash 是 客戶端 Hash 摘要,用于驗證客戶端合法性 ClientHash=Base64(MD5(ClientVersion|客戶端 中國電信動漫產(chǎn)品平臺接口規(guī)范 17 內(nèi)置密碼 ) welPage 是 Binary 是否顯示歡迎頁 請求消息體: 無 響應消息: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 RegisterRsp Response 1 無 Action ClientInfo RegisterRsp 0.1 無 客戶端需要升級時包含該節(jié)點 updateVersion ClientInfo 1 String 無 客戶端升級版本號 updateURL ClientInfo 1 String 無 客戶端升級地址 mustUpdate ClientInfo 1 Boolean 無 是否強制升級 updateMessage ClientInfo 0.1 String 無 客戶端升級加強特性描述信息,用于用戶提示,允許為空 UserInfo RegisterRsp 0.1 無 用戶基本信息 客戶端需要強制進行版本升級時該節(jié)點為空 userID UserInfo 1 String 無 用戶唯一標識 amount UserInfo 1 Integer 無 用戶當前余額 point UserInfo 1 Integer 無 用戶當前積分 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 書簽添加時間 yymmddhhmmss chapterId sysBookmarkList 1 String 無 章節(jié) ID chapterName sysBookmarkList 1 String 無 章節(jié)名稱 pageId sysBookmarkList 1 Integer 無 書簽頁編號 pushContent homepageInfo 1 Content 針 對用戶的推薦內(nèi)容 Special RegisterRsp 1 主菜單專題欄目更新 spcPic Special 1 專題圖片 中國電信動漫產(chǎn)品平臺接口規(guī)范 18 spcName Special 1 專題名稱 客戶端退出接口( quit) 接口描述 客戶端退出接口 接口消息定義 請求方法: GET /portalapi 請求消息體: 參數(shù)名稱 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 quitReq Request 1 Action lashBookmark quitReq 1 上報用戶在線觀看漫畫的系 統(tǒng)書簽 type lastBookmark 1 Integer 1:系統(tǒng)書簽 2:用戶書簽 (此處強制為 1) contentId lastBookmark 1 String 內(nèi)容 id pageId lastBookmark 1 Integer 頁編號 響應消息: 無,通過 HTTP header 的響應結果碼返回操作結果。 5.7.2 個性化接口 綁定用戶帳戶接口 ( addUserData) 接口描述 用戶以非 CTWAP 方式訪問動漫平臺,客戶端發(fā)起短信注冊的同時,客戶端上報平臺用戶填寫的用戶名和密碼。 接 口消息定義 請求方法: POST /portalapi 請求消息體: 中國電信動漫產(chǎn)品平臺接口規(guī)范 19 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 AddUserDataReq Request 1 userData AddUserDataReq 1 userName userData 1 String 用戶名(郵箱或其他手機號) passWrd userData 1 String 用戶密碼 響應消息: 無,通過 HTTP header 的響應結果碼返回操作結果。 獲取個人信息接口( getProfile) 接口描述 獲取個人信息 接口消息定義 請求方法: Get/portalapi 請求消息體: 無 響應消息: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 getProfileRsp Response UserInfo getProfileRsp 1 string 無 用戶信息 nickName UserInfo 1 string 無 昵稱 Mail UserInfo 個人郵箱 point UserInfo 1 Integer 無 用戶積分 amount UserInfo 余額 個人信息更新接口 ( setProfile) 接口描述 更新 個人信息 接口消息定義 中國電信動漫產(chǎn)品平臺接口規(guī)范 20 請求方法: POST/portalapi 請求消息體: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 setProfileReq Request 1 UserInfo setProfileReq 1 string 用戶信息 nickName UserInfo 1 string 昵稱 Mail UserInfo string 個人郵箱 響應消息: 無,通過 HTTP header 的響應結果碼返回操作結果。 客戶端皮膚獲取接口( getSkinPkg) 接口描述 獲取 客戶端 皮膚配色方案 接口消息定義 請求方法: GET /portalapi 請求消息體: 無 響應消息: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 GetSkinPkgRsp Response 1 無 skinPkg GetSkinPkgRsp 1.n 無 皮膚配色方案 border skinPkg 1 Rgb 值 邊框 顏色 text skinPkg 1 Rgb 值 文 字 顏色 focus skinPkg 1 Rgb 值 焦點 色 button skinPkg 1 Rgb 值 按鈕 背景色 listBkgnd skinPkg 1 Rgb 值 欄目列表 背景色 picture skinPkg 1 背景底紋圖片 description skinPkg 1 無 描述信息 中國電信動漫產(chǎn)品平臺接口規(guī)范 21 5.7.3 內(nèi)容信息同步 接口 內(nèi)容列表獲取接口 ( getContentList) 接口描述 獲取當前內(nèi)容子內(nèi)容列表信息 接口消息定義 請求方法: GET/portalapi?ContentID=xxx& ContentCount=xxx& Offset=xxx 參數(shù)名稱 是否必選 數(shù)據(jù)類型 描述 長度 ContentID 是 String 當前選擇的內(nèi)容列表 ID 16 ContentCount 是 Integer 請求的本內(nèi)容列表中的內(nèi)容個數(shù),若需要全部取出則此字段寫為 0 8 Offset 是 Integer 需要顯示的內(nèi)容與第一條記錄的偏移量 8 請求消息體: 無 響應消息: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 GetContentListRsp Response 1 無 ContentCount GetContentListRsp 1 Integer 無 請求的內(nèi)容列表中包含的內(nèi)容個數(shù) ContentList GetContentListRsp Content 請求內(nèi)容列表 內(nèi)容詳情獲取接口 ( getContentDetail) 接口描述 獲取當前內(nèi)容的詳情 接口消息定義 請求方法: GET /portalapi?ContentID=xxx 中國電信動漫產(chǎn)品平臺接口規(guī)范 22 參數(shù)名稱 是否必選 數(shù)據(jù)類型 描述 長度 ContentID 是 String 當前選擇的內(nèi)容列表 ID 16 請求消息體: 無 響應消息: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù) 數(shù)據(jù)類型 節(jié)點屬性 描述 GetContentDetailRsp Response 1 無 ContentType GetContentDetailRsp 1 Integer 無 內(nèi)容 ContentDetail GetContentDetailRsp ContentDetail 節(jié)目詳細內(nèi)容 PrevContentID GetContentDetailRsp String 節(jié)目列表中前一個節(jié)目 ID,如是第一個 ,該字段為空 NextContentID GetContentDetailRsp String 節(jié)目列表中后一個節(jié)目 ID,如是最后一個,該字段為空 ProductList GetContentDetailRsp Product 可訂購的產(chǎn)品列表,包括訂購章節(jié)或者包月 內(nèi)容章節(jié)獲取接口 ( getChapter) 接口描述 獲取每個內(nèi)容 ID 下的 內(nèi)容章節(jié)列表,包括漫畫章節(jié)列表和動畫分級列表 接口消息定義 請求方法: GET /portalapi?ContentID=xxx&start=xxx&count=xxx 參數(shù)名稱 是否必選 數(shù)據(jù)類型 描述 長度 ContentID 是 String 當前選擇的內(nèi)容列表 ID 16 start 否 Integer 起始頁編號 count 否 Integer 需要顯示的個數(shù) 缺省使用平臺默認配置 中國電信動漫產(chǎn)品平臺接口規(guī)范 23 請求消息體: 無 響應消息: 節(jié)點標識 父節(jié)點標識 出現(xiàn)次數(shù)

溫馨提示

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

評論

0/150

提交評論