史上最全互聯(lián)網(wǎng)網(wǎng)站產(chǎn)品需求說明書_第1頁
史上最全互聯(lián)網(wǎng)網(wǎng)站產(chǎn)品需求說明書_第2頁
史上最全互聯(lián)網(wǎng)網(wǎng)站產(chǎn)品需求說明書_第3頁
史上最全互聯(lián)網(wǎng)網(wǎng)站產(chǎn)品需求說明書_第4頁
史上最全互聯(lián)網(wǎng)網(wǎng)站產(chǎn)品需求說明書_第5頁
已閱讀5頁,還剩25頁未讀 繼續(xù)免費(fèi)閱讀

下載本文檔

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

文檔簡介

1、PRD文件編號SPI-doc- TIP-PRD作者黑羽文檔版本V0.6最后修改日期2009/1/20版本號0.6TOP接入系統(tǒng)(Taobao Intergration Platform)產(chǎn)品需求說明書編 寫 人: 黑羽 編寫時(shí)間: 2009/1/20 修訂控制頁編號文檔版本修訂章節(jié)修訂原因修訂日期修訂人 1V0.11-7創(chuàng)建2008.12.22黑羽2V0.25.2.1-5.2.5根據(jù)NCP和平臺組會議修改2008.12.28黑羽3V0.35.1 5.2根據(jù)29日周一TOP架構(gòu)討論會,劃分清TIP的需求優(yōu)先級、子系統(tǒng)結(jié)構(gòu)而調(diào)整2009.1.5黑羽4V0.45.1消息中心類型添加,API監(jiān)控調(diào)用管

2、理2009.1.8黑羽5V0.51.1, 5.1.1,5.1.2根據(jù)會議批注內(nèi)容補(bǔ)充和完善2009.1.16黑羽6V0.61.1-1.4, 5.1.2,5.2.1修訂2009/1/20黑羽78910目 錄1概述51.1名詞說明51.2產(chǎn)品概述及目標(biāo)51.3產(chǎn)品roadmap51.4產(chǎn)品風(fēng)險(xiǎn)62使用者需求62.1需求描述63可選方案64效益成本分析74.1效益預(yù)測74.2產(chǎn)品技術(shù)中心成本74.3非產(chǎn)品技術(shù)中心的支持成本85功能需求85.1功能總覽85.2功能詳情105.3整合需求115.4BETA測試需求116非功能需求11產(chǎn)品營銷需求11規(guī)則變更需求12產(chǎn)品服務(wù)需求12法務(wù)需求12財(cái)務(wù)需求12

3、幫助需求13安全性需求137上、下線需求137.1上線時(shí)限需求137.2下線需求(活動類需求必須明確下線時(shí)間)138運(yùn)營計(jì)劃13請與以下部門討論P(yáng)RD序號OK?部門溝通內(nèi)容1.運(yùn)營中心:商城、集市、二手閑置、門戶n 協(xié)助設(shè)定產(chǎn)品的Road Mapn 協(xié)助設(shè)定target customer:使用者n 協(xié)助評估:營銷/推廣需求n 協(xié)助設(shè)定商業(yè)目標(biāo)2.運(yùn)營中心:網(wǎng)站運(yùn)營n 協(xié)助設(shè)定產(chǎn)品的Road Mapn 協(xié)助設(shè)定target customer:使用者n 協(xié)助評估:營銷/推廣需求n 協(xié)助設(shè)定商業(yè)目標(biāo)3.客戶中心:客服服務(wù)部n 討論客服如何支持:客服需求n 協(xié)助評估詐欺/數(shù)據(jù)竄改風(fēng)險(xiǎn):欺詐/數(shù)據(jù)竄改風(fēng)

4、險(xiǎn)、不當(dāng)使用風(fēng)險(xiǎn)n 預(yù)測客服成本、工作量4.客戶中心:網(wǎng)絡(luò)安全部n 評估安全性5.產(chǎn)品技術(shù)中心:系統(tǒng)分析師 虛擬團(tuán)隊(duì)n 討論以確定方案的規(guī)模評估、推出計(jì)劃n 進(jìn)行技術(shù)可行性分析,提出關(guān)鍵問題的技術(shù)解決方案n 評估系統(tǒng)規(guī)模,數(shù)據(jù)量,所需資源等n 協(xié)助評估風(fēng)險(xiǎn)6.產(chǎn)品技術(shù)中心:項(xiàng)目經(jīng)理n 協(xié)助確定產(chǎn)品發(fā)布日期n 協(xié)助確定產(chǎn)品成本n 協(xié)助評估風(fēng)險(xiǎn)7.產(chǎn)品技術(shù)中心:用戶體驗(yàn)設(shè)計(jì)之交互設(shè)計(jì)師n 協(xié)助制作Demon 協(xié)助確定 use flow:用戶使用方式 8.財(cái)務(wù)分析中心:財(cái)務(wù)組n 請?jiān)u估財(cái)務(wù)需求n 協(xié)助評估風(fēng)險(xiǎn)9.財(cái)務(wù)分析部:數(shù)據(jù)分析組n 協(xié)助確定如何度量產(chǎn)品目標(biāo)10.行政管理中心:法務(wù)部n 協(xié)助評估

5、法務(wù)問題并檢視合作伙伴:使用者數(shù)據(jù)需求、 法務(wù)需求、 版權(quán)、隱私權(quán)等需求n 協(xié)助評估風(fēng)險(xiǎn):詐欺/數(shù)據(jù)竄改風(fēng)險(xiǎn)、 不當(dāng)使用風(fēng)險(xiǎn)11.規(guī)則委員會n 協(xié)助評估規(guī)則變更的影響12.支付寶n 協(xié)助確定接口、合作方式等13.阿里軟件n 協(xié)助確定接口、合作方式等1 概述1.1 名詞說明介紹本文檔中會使用到的專用名詞,如:新名詞、產(chǎn)品內(nèi)實(shí)體單位,請盡量使用大眾可理解的名詞名稱說明開放平臺以開放OpenAPI為核心的服務(wù)開放系統(tǒng)。包括開放數(shù)據(jù)、開放平臺和開放的業(yè)務(wù)方入口。TOP全稱 : Taobao Open Platform, 淘寶開放平臺App應(yīng)用,本文中指由第三方開發(fā)的,需要調(diào)用淘寶TOP來完成業(yè)務(wù)的應(yīng)用

6、程序。通常表現(xiàn)為瀏覽器端的頁面插件,桌面端的應(yīng)用程序。ISVIndependent Software Vender, 獨(dú)立軟件開發(fā)商。Role業(yè)務(wù)方角色,對應(yīng)于不同的API訪問權(quán)限和監(jiān)控策略。包括:買家、賣家、高級賣家等TPS每秒業(yè)務(wù)處理量。1.2 產(chǎn)品概述及目標(biāo)請以三到五段文字摘要說明您所提出的新服務(wù)(包含推出新產(chǎn)品、現(xiàn)有產(chǎn)品重新設(shè)計(jì)或升級、現(xiàn)有服務(wù)推出新功能)及目標(biāo);請包括:1、 產(chǎn)品背景說明;淘寶開放平臺是建立大淘寶的關(guān)鍵要素之一。以圍繞淘寶開放數(shù)據(jù)和業(yè)務(wù)為核心,把握商業(yè)趨勢,以第三方開發(fā)軟件為助力,建立繁榮的商業(yè)生態(tài)圈。對于外部數(shù)據(jù)的調(diào)用和監(jiān)管,是淘寶開放中最重要的環(huán)節(jié)之一。同時(shí),在可

7、預(yù)見的外部數(shù)據(jù)調(diào)用大規(guī)模增長時(shí),淘寶開放平臺也必須擁有適應(yīng)的機(jī)制。這些就是TIP(淘寶接入平臺)的商業(yè)背景和需求。2、 產(chǎn)品的目標(biāo)客戶;從TIP系統(tǒng)的使用來說,有外部客戶和內(nèi)部用戶外部用戶:第三方開發(fā)者通過開發(fā)的App對TIP平臺發(fā)出數(shù)據(jù)調(diào)用請求。內(nèi)部用戶:a) 開發(fā)者社區(qū)。 開發(fā)者通過開發(fā)者社區(qū)系統(tǒng)向TIP平臺請求相關(guān)App管理接口和開發(fā)者管理接口。b) Admin Center。 AdminCenter使用方為淘寶小二。Admin Center主要用于管理開放平臺的開發(fā)者、App、API;統(tǒng)計(jì)分析TOP數(shù)據(jù)調(diào)用的情況。1.3 產(chǎn)品roadmap請描述產(chǎn)品發(fā)展的各個(gè)階段,可以用圖表等多種方式

8、表述。產(chǎn)品發(fā)展階段階段描述時(shí)間1l 滿足外部數(shù)據(jù)調(diào)用的基本(P1)需求l 實(shí)現(xiàn)基本的監(jiān)控、管理功能l 對App和開發(fā)者有最基本的管理,支持Admin Center對單個(gè)ISV單個(gè)應(yīng)用手工納入TIP管理體系。l Admin Center有基本的ISV管理界面,和數(shù)據(jù)統(tǒng)計(jì)分析2009年3月2l 完善監(jiān)控與管理。(完成相關(guān)P2需求)。l 完善App和開發(fā)者管理,支持對批量的ISV批量應(yīng)用納入TIP管理體系。l 建立初步消息通知機(jī)制l Admin Center完善ISV/App管理界面,數(shù)據(jù)統(tǒng)計(jì)l 支持開發(fā)者社區(qū)批量接入第三方開發(fā)者2009年6月3l App和開發(fā)者管理支持第三方草根開發(fā)者。l 將沙箱

9、環(huán)境使用結(jié)合進(jìn)TIP的相關(guān)申請/管理流程l 支持開發(fā)者社區(qū)對第三方草根開發(fā)者的開放。l Admin Center完成半自動化的管理,集合對淘寶Hosting程序的相關(guān)支持2009年10月1.4 產(chǎn)品風(fēng)險(xiǎn)請描述產(chǎn)品可能存在的風(fēng)險(xiǎn),比如商務(wù)談判的風(fēng)險(xiǎn)?外部合作的風(fēng)險(xiǎn)?不當(dāng)使用的風(fēng)險(xiǎn) 等等。風(fēng)險(xiǎn)級別為高中低。風(fēng)險(xiǎn)風(fēng)險(xiǎn)級別描述監(jiān)控策略改善策略(/ TBD)2 使用者需求2.1 需求描述請說明此產(chǎn)品的目標(biāo)客戶、其需求及使用情境。如已做好personas(代表性角色描述),也請包含于此。請?jiān)敿?xì)說明此產(chǎn)品主要的使用案例目標(biāo)客戶最想由此產(chǎn)品滿足什么需求?最想藉由此產(chǎn)品解決什么問題?并根據(jù)每個(gè)不同的使用案例,區(qū)

10、別目標(biāo)客戶及其使用時(shí)的優(yōu)先級/重要性/頻率。目標(biāo)客戶需求描述場景描述優(yōu)先級3 可選方案列出所有可以選擇的達(dá)到該產(chǎn)品目標(biāo)的方案要點(diǎn)(主要思路),給各方案適當(dāng)?shù)脑u價(jià),并推薦最優(yōu)方案。如另有說明可選方案的文檔,歡迎使用。方案介紹優(yōu)點(diǎn)缺點(diǎn)方案1方案2方案34 效益成本分析4.1 效益預(yù)測請?zhí)峁┰诟鞣N產(chǎn)品環(huán)境中的效益預(yù)測,并標(biāo)明主要的變量及假設(shè),最好能包含現(xiàn)在和過去的效益數(shù)據(jù)。示例:指標(biāo)1網(wǎng)游每日支付寶成交額環(huán)境時(shí)間好中差現(xiàn)狀產(chǎn)品發(fā)布后一周產(chǎn)品發(fā)布后3周4.2 產(chǎn)品技術(shù)中心成本請列出設(shè)計(jì)及部署此產(chǎn)品的產(chǎn)品技術(shù)中心所需的資源需求,包括人力成本,軟硬件支出等。 (項(xiàng)目經(jīng)理應(yīng)提供協(xié)助)示例:人力資源工作內(nèi)容描

11、述成本(人日)備注產(chǎn)品經(jīng)理交互設(shè)計(jì)師開發(fā)測試非人力資源成本(元)描述硬件投入軟件投入其他4.3 非產(chǎn)品技術(shù)中心的支持成本請預(yù)估此產(chǎn)品有關(guān)的除產(chǎn)品技術(shù)部以外的支持投入。比如:需要客服部投入多少的資源用于該產(chǎn)品的服務(wù),需要運(yùn)營部投入多少的資源運(yùn)營該產(chǎn)品。示例:人力資源工作內(nèi)容描述成本(人日)備注客服專員運(yùn)營專員非人力資源成本(元)描述廣告位郵件群發(fā)5 功能需求請?jiān)敿?xì)說明此產(chǎn)品主要功能及內(nèi)容(除了使用者所需的功能外,也請說明公司內(nèi)部操作及維護(hù)產(chǎn)品所需要的功能或工具,例如報(bào)表、管理使用者或者維護(hù)網(wǎng)站內(nèi)容的工具、客戶服務(wù)工具等等。5.1 功能總覽請分別列出所有重要的功能及內(nèi)容模塊。建議使用圖表來形象闡述

12、本產(chǎn)品各個(gè)組成部分的關(guān)系。功能總表名稱描述優(yōu)先級備注1. TIP Router +Gateway淘寶接入平臺網(wǎng)關(guān):l 分發(fā)外部程序調(diào)用淘寶業(yè)務(wù)數(shù)據(jù)的請求。l 監(jiān)控、記錄和限制外部調(diào)用請求l 主動通知應(yīng)用程序信息12. Taobao Intergration Manager淘寶平臺集成管理器:l 提供管理開發(fā)者接口,用于監(jiān)控和規(guī)范他們開發(fā)行為,并劃分等級。l 提供管理App信息接口,監(jiān)控和調(diào)整App使用狀態(tài);與API調(diào)用或權(quán)限控制l 提供管理API訂購狀態(tài)接口l 區(qū)分API使用角色,和其他TIP子系統(tǒng)協(xié)作共同限制業(yè)務(wù)角色的各種權(quán)限。13. TIP Admin Center淘寶服務(wù)調(diào)用管理中心:l

13、 小二人工管理和調(diào)整開發(fā)者,API,APP的后臺工具l 展示淘寶各項(xiàng)服務(wù)的調(diào)用情況的圖表報(bào)告。含開發(fā)者、API、APP等相關(guān)數(shù)據(jù)。15.2 功能詳情5.1.1 TIP服務(wù)接入TIP的服務(wù)接入需要處理外部業(yè)務(wù)數(shù)據(jù)請求、支持應(yīng)用能夠注冊和偵聽消息,同時(shí)還要進(jìn)行業(yè)務(wù)數(shù)據(jù)調(diào)用的監(jiān)控,以及對自身性能的監(jiān)控。5.1.1.1 業(yè)務(wù)數(shù)據(jù)請求l 簡要說明驗(yàn)證外部數(shù)據(jù)請求合法性,再將請求轉(zhuǎn)發(fā)給相關(guān)OpenAPI或內(nèi)部系統(tǒng)。l 業(yè)務(wù)規(guī)則App上架流程參考:1. ISV資格申請2. 沙箱測試3. 小二審核4. 正常發(fā)布序號優(yōu)先級需求名稱需求描述1.1驗(yàn)證請求合法性l 驗(yàn)證App身份和狀態(tài)n 驗(yàn)證App是否在TIM中合

14、法注冊n 驗(yàn)證App狀態(tài)是否是正常使用狀態(tài)l 業(yè)務(wù)方身份合法性合法狀態(tài)包括哪幾種可能考慮:沙箱階段正式使用階段nl 驗(yàn)證會話session合法性n 本次會話是否真實(shí)有效n 會話是否過期n 傳入?yún)?shù)是否有效l 驗(yàn)證App請求是否越權(quán)n 當(dāng)前App請求的API與其在TIM中注冊的API權(quán)限范圍是否相符n 當(dāng)前App請求的API與終端用戶在TIM中注冊的角色權(quán)限范圍是否相符l 驗(yàn)證調(diào)用方是否在黑名單中n App是否在黑名單中n 域名或IP地址是否在黑名單中n 終端用戶是否在黑名單中2.四種會話驗(yàn)證機(jī)制根據(jù)App在申請時(shí),申請的API權(quán)限范圍和使用描述,第一期由小二決定App對應(yīng)下列那一種應(yīng)用方式。并

15、和這種方式綁定。l 固定時(shí)間SessionKey當(dāng)App應(yīng)用需要在固定時(shí)間內(nèi)運(yùn)行時(shí),使用這一種方式授權(quán)訪問時(shí)間。l 根據(jù)訪問延遲Sessionkey避免用戶在短時(shí)間內(nèi)重復(fù)登錄,影響軟件運(yùn)作和用戶體驗(yàn)l 兩次調(diào)用間隔不超過15分鐘時(shí),自動延長15分鐘l 15分鐘之內(nèi),沒有有效調(diào)用,會話失效l 使用一次失效Sessionkey單次調(diào)用后即失效,如同買家功能中訂單確認(rèn)。每次確認(rèn)都需要認(rèn)證一次。l 通知失效SessionKey會話一直有效,除非由我們主動終止。場景:一個(gè)與淘寶對接的ERP系統(tǒng)一直監(jiān)控訂單的狀態(tài)。3.1業(yè)務(wù)方身份驗(yàn)證l 當(dāng)所調(diào)用請求需要終端用戶登錄時(shí),調(diào)用相關(guān)驗(yàn)證程序來驗(yàn)證用戶身份。相關(guān)

16、驗(yàn)證程序,在本期表現(xiàn)為:n 彈出的一個(gè)域內(nèi)的瀏覽器窗口n 內(nèi)含賬戶名和密碼輸入框l 保證用戶輸入賬戶和密碼的安全性4.1轉(zhuǎn)發(fā)請求l 將合法API請求轉(zhuǎn)發(fā)給相應(yīng)OpenAPI5.1返回?cái)?shù)據(jù)的格式l 將OpenAPI返回的數(shù)據(jù)對象按調(diào)用方要求的格式返回l 支持常用的數(shù)據(jù)格式n XMLn JSONl 易于擴(kuò)展成其他數(shù)據(jù)格式。l 界面原型l 執(zhí)行者應(yīng)用程序(App)l 前置條件l 后置條件l 主流程 n 用戶在客戶端的App中登錄n 根據(jù)App類型生成相應(yīng)的Session機(jī)制n App從客戶端發(fā)起數(shù)據(jù)請求n Gateway返回OpenAPI訪問結(jié)果5.1.1.2 消息中心l 簡要說明由Gateway將

17、相關(guān)業(yè)務(wù)信息,主動通知給業(yè)務(wù)調(diào)用方。如,續(xù)費(fèi),訂單狀態(tài)改變、暫停,特殊通知l 業(yè)務(wù)規(guī)則序號優(yōu)先級需求名稱需求描述1.2提供消息通知機(jī)制Gateway可以通過主動調(diào)用App回調(diào)接口,傳輸消息中心注冊過的消息類型。消息中,包括:l 消息類型l 業(yè)務(wù)數(shù)據(jù):l 其余必需數(shù)據(jù):時(shí)間戳等典型應(yīng)用場景:一個(gè)大商家的自動訂單處理系統(tǒng):一旦用戶的某個(gè)訂單付款了,Gateway立刻調(diào)用自動訂單處理系統(tǒng)服務(wù)器的回調(diào)接口,發(fā)出“已付款”類型消息給它,內(nèi)含:消息類型:已付款業(yè)務(wù)數(shù)據(jù):訂單號,訂單相關(guān)信息必需數(shù)據(jù):時(shí)間戳訂單處理系統(tǒng)立刻開始進(jìn)入后續(xù)業(yè)務(wù)發(fā)貨流程。同理,之后,還有“已確認(rèn)收貨”與財(cái)務(wù)系統(tǒng)的對接,如,劃入應(yīng)收

18、賬款等。2.2消息類型l 訂單n “等待買家付款”n “價(jià)格已修改”n “買家已付款,等待賣家發(fā)貨”n “賣家已發(fā)貨,等待買家確認(rèn)”n “訂單成功”n “訂單取消”l 商品n 上架n 下架n 售完n 庫存報(bào)警l 服務(wù)狀態(tài)n 到期,停止服務(wù)服務(wù)恢復(fù)正常3.2使用消息接口的限制由于消息通知機(jī)制系統(tǒng)開銷成本較高,初期有限制的開放給高級開發(fā)者和特殊大商家角色使用。l 對于開發(fā)者的限制:只有4星級以上才可以調(diào)用接口l 對于用戶的限制:n 買家:高級用戶n 賣家:高級賣家4.2提供消息注冊接口l 規(guī)范App注冊偵聽某些類型事件(Event)的方法l 規(guī)范App提供的回調(diào)接口5.2消息類型注冊和撤銷使用方為

19、淘寶小二和淘寶自己的其他管理程序l 消息中心需提供注冊新事件的接口,規(guī)范事件的數(shù)據(jù)格式和規(guī)范。l 消息中心需提供撤銷某事件的接口,供取消事件。l 界面原型l 執(zhí)行者l 前置條件l 后置條件l 主流程 n 當(dāng)App注冊相關(guān)應(yīng)用偵聽時(shí),傳入商家號n 該商家的訂單或者商品變動時(shí),查找需要接受此消息的App列表n 由Gateway按列表逐一調(diào)用App回調(diào)接口5.1.1.3 監(jiān)控和性能l 簡要說明服務(wù)接入過程中,需要實(shí)現(xiàn)性能擴(kuò)展性、子系統(tǒng)獨(dú)立互不干擾;有效的記錄服務(wù)接入情況;監(jiān)控和管理接入使用。l 業(yè)務(wù)規(guī)則序號優(yōu)先級需求名稱需求描述1.1性能l 擴(kuò)展性由于獨(dú)立網(wǎng)店的推廣,和其他業(yè)務(wù)推廣,在可預(yù)計(jì)將來Op

20、enAPI訪問量的增長將會很迅速。TIP Gateway必須具備易于擴(kuò)展的軟硬件結(jié)構(gòu)來適應(yīng)這種快速增長。l 子系統(tǒng)互不干擾n 一個(gè)子系統(tǒng)的性能或者狀態(tài)發(fā)生變化時(shí),不會影響其余系統(tǒng)API的正常。2.1日志l 記錄OpenAPI調(diào)用情況n 日志異步記錄n 至少保留3個(gè)月的記錄l 記錄黑名單、性能監(jiān)控的相關(guān)數(shù)據(jù)l 提供日志相關(guān)接口n 提供給Admin Center使用n 提供給開發(fā)者社區(qū)等其他子系統(tǒng)調(diào)用(不建議)l 日志記錄內(nèi)容:² 當(dāng)前時(shí)間² api_key² app_path² 業(yè)務(wù)方id² 客戶端IP地址² app請求的content

21、-type² app請求的body length² service名稱 (對應(yīng)的API名稱)² uri:包含path和method_name,不包含service_name,如:/list/getMember;由鳳先評估² service返回的狀態(tài)碼² service返回的content-type² service響應(yīng)時(shí)間² service返回的body length² gateway響應(yīng)狀態(tài)碼3.2黑名單l 設(shè)置外部調(diào)用的黑名單。一旦調(diào)用方落在黑名單中,將失去數(shù)據(jù)訪問權(quán)。l 黑名單的分級n 暫時(shí)失效:禁止權(quán)限2小

22、時(shí),之后自動從黑名單中消除。加入和消除時(shí)間記錄入日志n 固定失效:必須調(diào)用解禁接口,才會從黑名單中消除l 提供黑名單的對外接口n 供Admin Center調(diào)用n 供其他子系統(tǒng)、其他部門調(diào)用4.1性能監(jiān)控l 實(shí)時(shí)監(jiān)控(延遲<=5分鐘)n 每分鐘內(nèi)單個(gè)AppKey或終端用戶調(diào)用頻率明顯異常時(shí):u 自動加入黑名單,設(shè)為“暫時(shí)失效”u 將相關(guān)信息記錄入日志n 每分鐘內(nèi)部分接口的性能反映異常(錯(cuò)誤碼)、掛起時(shí)u 自動調(diào)用Admin Center相關(guān)接口u 將相關(guān)信息記錄入日志l 分時(shí)段統(tǒng)計(jì)監(jiān)控n 每晚簡要分析TIP各模塊的狀態(tài)n 相關(guān)信息記錄入日志5.2流量控制l 能夠根據(jù)APP key和角色控

23、制單個(gè)API流量和調(diào)用次數(shù)。限制形式如下:n 總體限制:單個(gè)App在30秒內(nèi)訪問API次數(shù)限制n service限制: 單個(gè)API在30秒內(nèi)能被訪問的次數(shù)限制n 按service+uri進(jìn)行限制:可以對單個(gè)service+uri進(jìn)行設(shè)置,設(shè)置特定的service+uri每秒能被一個(gè)app訪問的次數(shù)n 按api_key+service_name進(jìn)行限制:可以按單個(gè)api_key+service_name進(jìn)行設(shè)置,設(shè)置特定的api_key對特定的service_name每秒能訪問的次數(shù)n 按api_key+service_name+uri進(jìn)行限制:可以對單個(gè)api_key+service_name

24、+uri進(jìn)行設(shè)置,設(shè)置特定的api_key對特定的service_name和uri每秒能訪問的次數(shù)l 甚至控制,單個(gè)API對不同角色返回不同結(jié)果。(P2)l 應(yīng)用場景如:淘寶助理的流量不加以控制,但別的就不行。淘寶助理可以調(diào)用批量接口對當(dāng)前Sessionkey中用戶商品操作,別的APP key不行。l 界面原型l 執(zhí)行者l 前置條件l 后置條件l 主流程 5.1.2 Taobao Intergration Manager (淘寶接入管理)l 提供管理開發(fā)者接口,用于監(jiān)控和規(guī)范他們開發(fā)行為,并劃分等級。l 提供管理App信息接口,監(jiān)控和調(diào)整App使用狀態(tài);與API調(diào)用或權(quán)限控制l 提供管理API

25、訂購狀態(tài)接口l 區(qū)分API使用角色,和其他TIP子系統(tǒng)協(xié)作共同限制業(yè)務(wù)角色的各種權(quán)限。5.1.2.1 開發(fā)者 管理l 簡要說明提供管理開發(fā)者的各種接口,l 業(yè)務(wù)規(guī)則序號優(yōu)先級需求名稱需求描述1.1需要錄入的開發(fā)者信息在開發(fā)者數(shù)據(jù)庫中,所需要記錄的開發(fā)者相關(guān)信息l 該開發(fā)者的id號l 常規(guī)信息:n 聯(lián)系人姓名n 公司n 通訊地址:n emaill 賬戶信息:n 收款人,收款人支付寶帳號l 對應(yīng)權(quán)限表:見對應(yīng)調(diào)用權(quán)限范圍l 等級n 分成若干級別,供日后運(yùn)營調(diào)用l 統(tǒng)計(jì)信息n 信用記錄n 應(yīng)用列表n 所擁有的App匯總統(tǒng)計(jì)數(shù)據(jù)l 歷史記錄l 其他備注2.2開發(fā)者 調(diào)用權(quán)限范圍l 記錄該開發(fā)者可以調(diào)用

26、的OpenAPI范圍l 應(yīng)用場景: 小二從AdminCenter中根據(jù)開發(fā)者的資質(zhì)來調(diào)整他的API訪問等級和權(quán)限。l 記錄開發(fā)者可以注冊偵聽的Gateway事件類型3.2開發(fā)者對應(yīng)等級l 每種開發(fā)者所可以訪問的API的范圍和API調(diào)用時(shí)的控制策略是不一樣的。l 定為5個(gè)等級:1-5星級l 不同級別,擁有默認(rèn)的調(diào)用權(quán)限范圍如果之前權(quán)限范圍中有超出 等級對應(yīng)默認(rèn)范圍,按合集處理。4.1開發(fā)者 Manager對外接口只提供接口,由其他子系統(tǒng)調(diào)用,如,由小二在AdminCenter中調(diào)用;開發(fā)者社區(qū)的相關(guān)調(diào)用等。l 增加開發(fā)者接口l 刪除開發(fā)者接口l 修改開發(fā)者接口l 查詢開發(fā)者接口l 界面原型無l

27、執(zhí)行者外部調(diào)用方l 前置條件無l 后置條件無l 主流程 無5.1.2.2 App 管理l 簡要說明提供各種App信息的對外接口l 業(yè)務(wù)規(guī)則序號優(yōu)先級需求名稱需求描述6.1App的數(shù)據(jù)內(nèi)容l 應(yīng)用名稱l 必備接入數(shù)據(jù):n 應(yīng)用Appkeyn 應(yīng)用接入方式:代碼嵌入/Iframe框架嵌入/客戶端n 應(yīng)用類型:旺鋪插件/社區(qū)插件/NCP插件/獨(dú)立外部插件n 應(yīng)用是否需要綁定用戶Sessionl 基本信息:n 應(yīng)用的圖標(biāo)分三種圖標(biāo)大小,20X20, 40X40,80X80n 應(yīng)用的簡介n 應(yīng)用的詳細(xì)描述l 應(yīng)用的回調(diào)接口地址(如果是Client插件,則不需要回調(diào)地址)l App key所對應(yīng)的權(quán)限范圍

28、表l App對應(yīng)的狀態(tài)l 統(tǒng)計(jì)信息n 當(dāng)前使用數(shù)n 所擁有的API調(diào)用匯總統(tǒng)計(jì)數(shù)據(jù)7.1App Key對應(yīng)的權(quán)限范圍表l 記錄該App可以調(diào)用的OpenAPI范圍l 記錄App可以注冊偵聽的Gateway事件類型8.1App的狀態(tài)l 待審核l 審核失敗l 上架中(暫留)正在發(fā)布過程中.l 正常使用l 暫停使用9.1App Manager對外接口只提供接口,由其他子系統(tǒng)調(diào)用,如,由小二在AdminCenter中調(diào)用l 增加App接口l 刪除App接口l 修改App接口l 查詢App接口l 界面原型l 執(zhí)行者l 前置條件l 后置條件l 主流程 5.1.2.3 API 管理l 簡要說明提供各種App

29、信息的對外接口l 業(yè)務(wù)規(guī)則序號優(yōu)先級需求名稱需求描述10.2OpenAPI對應(yīng)信息OpenAPi對應(yīng)的角色信息。OpenAPI所對應(yīng)的sessionkey是否需要綁定,和何種類型。/TBDl OpenAPI對應(yīng)的角色信息l OpenAPI對應(yīng)的Sessionkey是否需要綁定,何種類型。11.2消息通知API對應(yīng)信息12.2可以設(shè)置OpenAPI的角色l 具體設(shè)置OpenAPI能被哪幾種角色可以訪問。l 角色列表見:5.1.2.4l OpenAPI l 界面原型l 執(zhí)行者l 前置條件l 后置條件l 主流程 5.1.2.4 Role 管理 l 簡要說明提供各種終端用戶角色信息的對外接口l 業(yè)務(wù)規(guī)

30、則序號優(yōu)先級需求名稱需求描述13.2終端用戶角色l 每個(gè)角色對應(yīng)一組OpenAPI權(quán)限、注冊偵聽消息權(quán)限l 角色對應(yīng)的Appl 每個(gè)App中需要的角色由App來決定。14.2用戶角色需要細(xì)化到每個(gè)接口上。買家:l 普通買家:沒有發(fā)生賣出交易的用戶l 高級買家:可以使用TIP的消息接口的用戶,該類用戶數(shù)據(jù)可以產(chǎn)生消息發(fā)送。賣家:l 普通賣家:接口使用權(quán)限低。l 旺鋪賣家:具有API大部分使用權(quán)限,但在產(chǎn)品發(fā)布等接口上不具有權(quán)限l 商城賣家和外部網(wǎng)店賣家:具有API所有使用權(quán)限l 高級賣家:除了具有API使用權(quán)限外,還可以使用TIP消息接口。淘客:l 可以渠道15.2用戶角色的綁定l 在開發(fā)者社區(qū)

31、提供專門的角色權(quán)限申請頁面l 在AdminCenter中提供“角色權(quán)限”勾選范圍l 界面原型l 執(zhí)行者l 前置條件l 后置條件l 主流程 3.25.2.1 AdminCenter5.2.1.1 管理開發(fā)者的部分統(tǒng)計(jì)需求:1開發(fā)者調(diào)用統(tǒng)計(jì)以圖表形式表現(xiàn)如下數(shù)據(jù)l 總調(diào)用數(shù)、頻率的日線圖l 調(diào)用的各個(gè)接口次數(shù)、圖表l 所有App數(shù)量統(tǒng)計(jì)、l 所有開發(fā)者的分類統(tǒng)計(jì)管理需求:序號優(yōu)先級需求名稱需求描述5.2待審核開發(fā)者1、 列表顯示字段有:開發(fā)者的類別、聯(lián)系姓名、電子郵件地址、網(wǎng)址、聯(lián)系電話、已通過的角色。2、 可做的操作有:通過、拒絕a) 通過后則待審用戶自動進(jìn)入下一個(gè)角色的待審列表中。b) 拒絕則

32、需要輸入拒絕理由。審核機(jī)制采取一票否決制。6.2已通過開發(fā)者1、 列表顯示字段有:開發(fā)者的類別、聯(lián)系姓名、電子郵件地址、網(wǎng)址、聯(lián)系電話,開發(fā)者注冊的應(yīng)用(點(diǎn)擊后可以查看應(yīng)用的詳細(xì)資料)??勺霾僮饔校簞h除7.2刪除開發(fā)者1、 被刪除的開發(fā)者如沒有注冊應(yīng)用,則輸入完刪除理由后從列表中消失。被刪除的開發(fā)者如有注冊應(yīng)用,輸入刪除理由后,該開發(fā)者所屬應(yīng)用也全部被刪除,已使用該應(yīng)用的模塊也相應(yīng)被刪除。序號優(yōu)先級需求名稱需求描述8.2開發(fā)者列表1、 以表格方式列出所有開發(fā)者。2、 顯示字段為開發(fā)者類別/姓名/電郵/應(yīng)用數(shù)目(已通過/未通過)(/TBD)l 界面原型l 執(zhí)行者開發(fā)者l 前置條件登錄進(jìn)入開發(fā)者社

33、區(qū),進(jìn)入管理中心l 后置條件無l 主流程 5.2.1.2 管理App的部分l 簡要說明數(shù)據(jù)中心,存儲App(應(yīng)用)和開發(fā)者相關(guān)信息校驗(yàn)App對應(yīng)的角色。l 業(yè)務(wù)規(guī)則統(tǒng)計(jì)需求1App應(yīng)用統(tǒng)計(jì)以圖表形式表現(xiàn)如下數(shù)據(jù)l 注冊數(shù)統(tǒng)計(jì)l App單個(gè)調(diào)用數(shù)統(tǒng)計(jì)、列表l 分類統(tǒng)計(jì)l 趨勢統(tǒng)計(jì)序號優(yōu)先級需求名稱需求描述1.1添加新的應(yīng)用1、 需要填寫的字段為:l 應(yīng)用名稱l 必備接入數(shù)據(jù):n 應(yīng)用Appkeyn 應(yīng)用接入方式:代碼嵌入/Iframe框架嵌入/客戶端n 應(yīng)用類型:旺鋪插件/社區(qū)插件/NCP插件/獨(dú)立外部插件n 應(yīng)用是否需要綁定用戶Sessionl 基本信息:n 應(yīng)用的圖標(biāo)分三種圖標(biāo)大小,20X2

34、0, 40X40,80X80n 應(yīng)用的簡介n 應(yīng)用的詳細(xì)描述l 應(yīng)用的回調(diào)接口地址(如果是Client插件,則不需要回調(diào)地址)2、 提交后的提示信息中給出api_key,并再次判斷用戶是否有站點(diǎn),如無站點(diǎn)提示同注冊開發(fā)者時(shí)相同。注冊成功后,該應(yīng)用信息進(jìn)入調(diào)試狀態(tài)。2.1應(yīng)用詳細(xì)資料頁顯示應(yīng)用的詳細(xì)信息,顯示的內(nèi)容為添加應(yīng)用時(shí)填寫的內(nèi)容以及被使用次數(shù)、評論。序號優(yōu)先級需求名稱需求描述1.2.2修改應(yīng)用1、 已上線的應(yīng)用可修改a) 可修改所有字段b) 修改后,用戶可以選擇發(fā)布到調(diào)試環(huán)境或者是發(fā)布到正式環(huán)境,發(fā)布到調(diào)試環(huán)境的線上應(yīng)用,在調(diào)試環(huán)境中可以添加和使用,并不替換線上應(yīng)用。c) 選擇發(fā)布到正式

35、環(huán)境后修改后的信息進(jìn)入審核系統(tǒng),并不替換線上應(yīng)用信息。2、 審核中的新應(yīng)用修改不允許修改。修改通過后的應(yīng)用對老模塊升級。3.2下線應(yīng)用1、 已上線的應(yīng)用開發(fā)者可以修改為下線狀態(tài),審核流程如同修改3、 被批準(zhǔn)的下線應(yīng)用將從列表中消失,且不能被添加,但原添加的模塊可繼續(xù)使用。4.2刪除應(yīng)用1、 刪除上線狀態(tài)的應(yīng)用:提出申請后進(jìn)入審核流程,審核通過后凡是使用到該應(yīng)用的模塊一并被刪除。5.2下線應(yīng)用2、 已上線的應(yīng)用開發(fā)者可以修改為下線狀態(tài),審核流程如同修改4、 被批準(zhǔn)的下線應(yīng)用將從列表中消失,且不能被添加,但原添加的模塊可繼續(xù)使用。6.2下線應(yīng)用3、 已上線的應(yīng)用開發(fā)者可以修改為下線狀態(tài),審核流程如

36、同修改5、 被批準(zhǔn)的下線應(yīng)用將從列表中消失,且不能被添加,但原添加的模塊可繼續(xù)使用。序號優(yōu)先級需求名稱需求描述9.2應(yīng)用列表1、 應(yīng)用列表根據(jù)應(yīng)用的狀態(tài)分為以下幾個(gè)tab:已發(fā)布、調(diào)試中、審核中、被拒絕、下線、刪除。2、 已發(fā)布狀態(tài)的應(yīng)用為已經(jīng)通過審核,線上正在使用中的應(yīng)用。a) 顯示字段為:icon、名稱、上線時(shí)間、類別、類型、被使用次數(shù)、查看評論。b) 點(diǎn)擊icon或名稱可以查看應(yīng)用詳細(xì)資料。c) 可做的操作有:修改、刪除。3、 調(diào)試中的應(yīng)用為調(diào)試環(huán)境下才能添加和使用的應(yīng)用,線上環(huán)境并不能看到和被添加。a) 顯示的字段為:icon、名稱、提交時(shí)間、類別、類型。b) 點(diǎn)擊icon或名稱可以查

37、看應(yīng)用詳細(xì)資料。c) 可做的操作有:修改、發(fā)布、刪除。4、 審核中狀態(tài)的應(yīng)用為新應(yīng)用或修改后提交審核的應(yīng)用,目前處于開發(fā)環(huán)境中。a) 顯示字段為:icon、名稱、提交審核時(shí)間、類別、類型、狀態(tài)(新應(yīng)用還是老應(yīng)用修改后待審)。b) 點(diǎn)擊icon或名稱可以查看應(yīng)用詳細(xì)資料。c) 可做操作有:修改、刪除。d)5、 被拒絕狀態(tài)的應(yīng)用為新應(yīng)用或修改后提交審核的應(yīng)用被淘寶審核人員拒絕的應(yīng)用。a) 顯示字段為:icon、名稱、被拒絕時(shí)間、類別、類型、狀態(tài)(新應(yīng)用還是老應(yīng)用修改后待審)、查看拒絕理由b) 點(diǎn)擊icon或名稱可以查看應(yīng)用詳細(xì)資料。c) 新應(yīng)用被拒絕后可做的操作有:修改、刪除。點(diǎn)擊修改后流程同添加

38、新應(yīng)用;點(diǎn)擊刪除后,該應(yīng)用的信息從列表中消失。d) 老應(yīng)用修改被拒絕后無可作操作。6、 下線狀態(tài)的應(yīng)用為老應(yīng)用被開發(fā)者或淘寶審核者作出下線操作的應(yīng)用,該類應(yīng)用將不會在列表中出現(xiàn),且不能被添加,但已使用中的不受影響。a) 顯示字段為:icon、名稱、上線時(shí)間、下線時(shí)間、類別、類型、被使用次數(shù)、查看評論。b) 點(diǎn)擊icon或名稱可以查看應(yīng)用詳細(xì)資料。c) 可做的操作有:修改、刪除。7、 刪除狀態(tài)的應(yīng)用為被刪除的老應(yīng)用,包括開發(fā)者自己刪除和淘寶審核刪除。a) 顯示字段為:icon、名稱、上線時(shí)間、刪除時(shí)間、類別、類型、被使用次數(shù)、查看評論、刪除理由、刪除者的角色。b) 點(diǎn)擊icon或名稱可以查看應(yīng)用詳細(xì)資料。無任何可做的操作,僅僅是一個(gè)信息記錄。10.l 界面原型l 執(zhí)行者l 前置條件l 后置條件主流程5.2.1.3 管理API的部分l 簡要說明l 業(yè)務(wù)規(guī)則序號優(yōu)先級需求名稱需求描述16.1OpenAPI各項(xiàng)指標(biāo)統(tǒng)計(jì)l API接口調(diào)用次數(shù)統(tǒng)計(jì)l 所耗性能l 被調(diào)用的APP數(shù)目17.2單個(gè)OpenAPI的信息l 名

溫馨提示

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

評論

0/150

提交評論