Taobao产品需求说明书.docx





《Taobao产品需求说明书.docx》由会员分享,可在线阅读,更多相关《Taobao产品需求说明书.docx(34页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、PR!)文件编号SPI-doc- TIP-PRD作 者黑羽V0.6修改日.20xx/l/20版本号0.6TOP接入系统(TaobaoIntergration Platform)产品需求说明书编写人:黑羽编写时间:20xx/l/205功能需求请详细说明此产品主要功能及内容(除了使用者所需的功能外,也请说明公司内部操作及维 护产品所需要的功能或工具,例如报表、管理使用者或者维护网站内容的工具、客户服务工 具等等。5.1 功能总览请分别列出所花重要的功能及内容模块。建议使用图表来形象阐述本产品各个组成局部的关系。功能总表名称描述优先级备注1. TIP Router +Gateway淘宝接入平台网关:
2、 分发外部程序调用淘宝业务数据的请求。 监控、记录和限制外部调用请求 主动通知应用程序信息12. Taobao Intergration Manager淘宝平台集成管理器: 提供管理开发者接口,用于监控和规范他们开 发行为,并划分等级。 提供管理App信息接口,监控和调整A即使 用状态:与API调用或权限控制 提供管理API订购状态接3 区分API使用角色,和其他TIP子系统协作共 同限制业务角色的各种权限。13. TIP Admin Center淘宝服务调用管理中心: 小二人工管理和调整开发者,API. APP的后 台工具 展示淘宝各项服务的调用情况的图表报告。含 开发者、API. APP等
3、相关数据.15.2 功能详情TIP服务接入TIP的服务接入需要处理外部业务数据请求、支持应用能够注册和侦听消息,同时还要进行 业务数据调用的监控,以及对自身性能的监控。5.1.1.1 业务数据请求简要说明验证外部数据请求合法性,再将请求转发给相关OpenAPI或内部系统。业务规那么 批注|K1|:App上架流程参考:序号优先级需求名需求描述1 . ISV资格申请2 .沙箱测试3 .小二审核4 .正常发布1.1验证请求合法性 验证App身份和状态 验证App是否在TIM中合法注册 验证App状态是否是正常使用状态 业务方身份合法性 验证会话session合法性 本次会话是否真实有效批注|K2J:
4、合法状态包括哪几种可能考虑:沙箱阶段正式使用阶段 会诂是合建期 传入参数是否有效 验证App请求是否越权 当前App请求的API与其在TIM中注册的API权限范围是否相符 当前App请求的API与终端用户在T1M中注册的角色权限范围是 否相符 验证调用方是否在黑名单中 App是否在黑名单中 域名或IP地址是否在黑名单中 终端用户是否在黑名单中2.四种会话验证机制根据App在申请时,申请的API权限范围和使用描述,第一期由小二决定 App对应以下那一种应用方式。并和这种方式绑定。 固定时间SessionKey当App应用需要在固定时间内运行时,使用这一种方式授权访问时间。 根据访问延迟Sessi
5、onkey防止用户在短时间内重狂登录,影响软件运作和用户体验 两次调用间隔不超过15分钟时,自动延长15分钟界面原型 15分钟之内,没有有效调用,会话失效 使用一次失效Sessionkey单次调用后即失效,如同买家功能中订单确认。每次确认都需要认证 一次。 通知失效SessionKey会话一直有效,除非由我们主动终止.场景:一个与淘宝对接的ERP 系统一直监控订单的状态。3.1业务方身份验证 当所调用请求需要终端用户登录时,调用相关验证程序来验证用户身 份。相关验证程序,在本期表现为: 如出的一个taobao. com域内的浏览器窗口 内含账户名和密码输入框 保证用户输入账户和密码的安全性4.
6、1转发请求 将合法API请求转发给相应OpenAPI5.1返回数据的格式 将OpenAPI返回的数据对象按调用方要求的格式返回 支持常用的数据格式 XML JSON易于扩展成其他数据格式。执行者应用程序(App)前置条件 后置条件主流程 用户在客户端的App中登录根据App类型生成相应的Session机制 App从客户端发起数据请求Gateway返回OpenAPI访问结果消息中心简要说明由Gateway将相关业务信息,主动通知给业务调用方。如,续费,订单状态改变、暂停, 特殊通知业务规那么序号优先级需名需求描述1.2提供消息通知机制Gateway可以通过主动调用App回调接口,传输消息中心注册
7、过的消息类 型。消息中,包括: 消息类型 业务数据: 其余必需数据:时间戳等典型应用场景:一个大商家的自动订单处理系统:一旦用户的某个订单付款了,Gateway立刻调用白动订单处理系统服务器 的回调接口,发出“已付款”类型消息给它,内含:消息类型:已付款业务数据:订单号,订单相关信息必需数据:时间戳订单处理系统立刻开始进入后续业务一一发货流程。同理,之后,还有“已确认收货”与财务系统的对接,如,划入应收账款 等。2.2消息类型 订单 “等待买家付款” “价格已修改” “买家已付款,等待卖家发货” “卖家已发货,等待买家确认” “订单成功” “订单取消” 商品 上架 下架 售完 库存报警 服务状
8、态 到期,停止服务服务恢第正常3.2使用消息接口的限 制由于消息通知机制系统开销本钱较高,初期有限制的开放给高级开发者和 特殊大商家角色使用。 界面原型 对于开发者的限制:只有4星级以上才可以调用接口 对于用户的限制: 买家:高级用户 卖家:高级卖家4.2提供消息注册接口 规范App注册侦听某些类型事件(Event)的方法 规范App提供的回调接口5.2消息类型注册和撤 销使用方为淘宝小二和淘宝自己的其他管理程序 消息中心需提供注册新事件的接口,规范事件的数据格式和规范。 消息中心需提供撤销某事件的接口,供取消事件。执行者 前置条件后置条件 主流程当App注册相关应用侦听时,传入商家号 该商家
9、的订单或者商品变动时,代找需要接受此消息的App列表由Gateway按列表逐一调用App回调接口监控和性能简要说明服务接入过程中,需要实现性能扩展性、子系统独立互不干扰;有效的记录服务接入情 况;监控和管理接入使用。业务规那么序号优先级需求名称需求描述1.1性能扩展性由于独立网店的推广,和其他业务推广,在可预计将来OpenAPI访问 量的增长将会很迅速。TIP Galeway必须具备易于扩展的软硬件结构来适应这种快速增长。子系统互不干扰 一个子系统的性能或者状态发生变化时,不会影响其余系统API 的正常。2.1日志 记录OpenAPI调用情况 日志异步记录 至少保存3个月的记录 记录黑名单、性
10、能监控的相关数据 提供日志相关接口 提供给Admin Center使用 提供给开发者社区等其他子系统调用(不建议) 日志记录内容:。当前时间。api_key。app_path。 业务方id。客户端1P地址 app 请求的 content-type app 请求的 body length service名称(对应的API名称) uri:包含 path 和 method_name.不包含 serice_name.如:/list/getMember:批注K3:由凤先群估 service返回的状态吗。 service 返回的 contcnt-typc。service响应时间。 service 返回的
11、body length。gateway响应状态码3.2黑名单 设置外部调用的黑名朝。一旦调用方落在黑名单中,将失去数据访问 权。 黑名单的分级 暂时失效:禁止权限2小时,之后白动从黑名单中消除。 加入和消除时间记录入日志 固定失效:必须调用解禁接口,才会从黑名单中消除 提供黑名单的对外接口供 Admin Center 调用供其他子系统、其他部门调用4.1性能监控 实时监控(延迟=5分钟) 每分钟内单个AppKey或终端用户调用频率明显异常时:自动加入黑名单,设为“酒时失效” 将相关信息记录入口志 每分钟内局部接口的性能反映异常(错误码)、挂起时 自动调用Admin Center相关接口将相关信
12、息记录入日志 分时段统计监控 每晚简要分析TIP各模块的状态 相关信息记录入日志5.2流量控制 能够根据APP key和角色控制单.个API流量和调用次数。限制形式如 下: 总体限制:单个App在30秒内访问API次数限制 service 限制:单个API在30秒内能被访问的次数限制 按sevice+uri进行限制:可以对单个service+uri进行设置,i殳置特定的service+uri每秒能 被一个app访问的次数 按 api_key+service_name 进行限制:可以按单个api_kcy+scn*icc_namc进行设置,设置特定的api_kcy 对特定的scrvicc_namc
13、每秒能访问的次数 按 api_key+$ervice_namc+uri 进行限制:可以对单个api_key+serqce_nan)e+uri进行设置,设置特定的 api_key对特定的service_name和uri每秒能访问的次数 甚至控制,单个API对不同角色返回不同结果。(P2) 应用场景如:淘宝助理的流病不加以控制,但别的就不行.淘宝助理 可以调用批量接口对当前Scssionkoy中用户商品操作,别的APPkoy 不行。 界面原型 执行者前置条件 后置条件主流程5.1.2 Taobao Intergration Manager (淘宝接入管理)提供管理开发者接口,用于监控和规范他们开发
14、行为,并划分等级。 提供管理App信息接口,监控和调整App使用状态;与API调用或权限控制 提供管理API订购状态接口区分API使用角色,和其他TIP子系统协作共同限制业务角色的各种权限开发者管理 简要说明提供管理开发者的各种接口, 业务规那么序号优先级需求名称需求描述I.1需要录入的开发者 信息在开发者数据库中,所需要记录的开发者相关信息 该开发者的id号 常规信息: 联系人姓名 公司 通讯地址: email 账户信息: 收款人,收款人支付宝帐号 对应权限表:见对应调用权限范围 等级 分成假设干级别,供日后运营调用 统计信息 信用记录 应用列表 所抑有的App汇总统计数据 历史记录 其他备
15、注2.2开发者调用权限 范用 记录该开发者可以调用的OpenAPl范围 应用场景:小二从AdminCenler中根据开发者的资质来调整他的API 访问等级和权限。 记录开发者可以注册侦听的Gateway事件类型3.2开发者对应等级 每种开发者所可以访问的API的范围和API调用时的控制策略是不一 样的。 定为5个等级:1-5星级 不同级别,拥有默认的调用权限范围如果之前权限范围中有超出等级对应默认范围,按合集处理。4.1开发者Manager对 外接口只提供接口,由其他子系统调用,如,由小二在AdminCenter中调用:开发者社区的相关调用等。 增加开发者接口 删除开发者接口 修改开发者接口
16、查询开发者接口界面原型无执行者 外部调用方 前置条件 无后置条件 无 主流程 无.1.2.2 App 管理简要说明提供各种App信息的对外接I 业务规那么序号优先级需求名称需求描述6.1App的数据内容 应用名称 必备接入数据: 应用 Appkey 应用接入方式:代码嵌入“frame框架嵌入/客户端 应用类型:旺铺插件/社区插件/NCP插件/独立外部插件 应用是否需要绑定用户Session 基本信息:应用的图标分三种图标大小,20X20, 40X40, 80X80应用的简介 应用的详细描述 应用的网调接口地址(如果是Client插件,那么不需要回调地址) A叩key所对应的权限范围表 App对
17、应的状态 统计信息 当前使用数 所拥有的API调用汇总统计数据7.1App Key对应的权限 范围表 记录该App可以调用的OpenAPI范围 记录App可以注册侦听的Gateway事件类型8.1App的状态 待审核 审核失败 上架中(暂留)正在发布过程中. 正常使用 笆停使用9.1App Manager对外接口只提供接口,由其他子系统调用,如,由小二在AdminCenier中调用 增加App接口 删除App接口 修改App接口 查询App接口界面原型 执行者前置条件 后置条件主流程5.1.2.3 API 管理简要说明提供各种App信息的对外接口 业务规那么修订控制页编号文档版本修订章节修订原
18、因修订日期修订人1V0. 11-7创立20xx. 12.22黑羽2V0.25. 2. 15. 2. 5根据NCP和平台组会议修改20xx. 12. 28黑羽3V0.35. 1 - 5. 2根据29日 周一 TOP架 构讨论会, 划分清TIP 的需求优先 级、子系统 结构而调整20xx. 1. 5黑羽4V0.45.1消息中心类 型添加,API 监控调用管理20xx.l,8黑羽5V0.51.1, 5.1.1 ,根据会议批注内容补充和完善黑羽6V0.61.1-1.4.修订20xx/l/20黑羽序号优先级需求名称需求描述10.2OpenAPl对应信息/TBD批注K4: OpenAPi对应的角色信息。
19、OpenAPl对应的角色信息 OpenAPl对应的Sessionkey是否需要绑定,何种类型。OpenAPl所对应的sessionkey是否需要绑定,和何种类 型。11.2消息通知API对应信息12.2可以设置OpenAPl 的角色 具体设置OpenAPl能被哪几种角色可以访问。 角色列表见: OpenAPl 界面原型执行者 前置条件后置条件 主流程5.1.2.4 Role 管理简要说明提供各种终端用户角色信息的对外接u业务规那么序号优先级需求名称需求描述13.2终端用户角色 每个角色对应一组OpenAPl权限、注册侦听消息权限 角色对应的App 每个App中需要的角色由App来决定。14.2
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Taobao 产品 需求 说明书

限制150内