1、PRD 文件编号 SPI-doc- TIP-PRD 作 者 黑羽 文档版本 V0.6 最后修改日期 2009/1/20 版本号 0.6 TOP 接入系统(Taobao Intergration Platform) 产品需求说明书 编 写 人： 黑羽 编写时间： 2009/1/20 PRD 第 2 页 共 30 页 修订控制页 编号 文档版本 修订章节 修订原因 修订日期 修订人 1 V0.1 1-7 创建 2008.12.22 黑羽 2 V0.2 5.2.1-5.2.5 根据 NCP 和 平台组会议 修改 2008.12.28 黑羽 3 V0.3 5.1 5.2 根据 29 日 周一 TOP
2、架 构讨论会， 划分清 TIP 的需求优先 级、子系统 结构而调整 2009.1.5 黑羽 4 V0.4 5.1 消息中心类 型添加， API 监控调 用管理 2009.1.8 黑羽 5 V0.5 1.1, 5.1.1，5.1.2 根据会议批 注内容补充 和完善 2009.1.16 黑羽 6 V0.6 1.1-1.4, 修订 2009/1/20 黑羽 PRD 第 3 页 共 30 页 5.1.2,5.2.1 7 8 9 10 PRD 第 4 页 共 30 页 目 录 1 概述 5 1.1 名词说明 5 1.2 产品概述及目标 5 1.3 产品 roadmap.5 1.4 产品风险 6 2 使用
3、者需求 6 2.1 需求描述 6 3 可选方案 6 4 效益成本分析 7 4.1 效益预测 7 4.2 产品技术中心成本 7 4.3 非产品技术中心的支持成本 8 5 功能需求 8 5.1 功能总览 8 5.2 功能详情 10 5.3 整合需求 11 5.4 BETA 测试需求 11 6 非功能需求 11 产品营销需求 11 规则变更需求 12 产品服务需求 12 法务需求 12 财务需求 12 帮助需求 13 安全性需求 13 7 上、下线需求 13 7.1 上线时限需求 13 7.2 下线需求（活动类需求必须明确下线时间） 13 8 运营计划 13 PRD 第 5 页 共 30 页 请与以
4、下部门讨论 PRD 序号 OK？ 部门 沟通内容 1. 运营中心： 商城、集市、 二手闲置、 门户 协助设定产品的 RaodMap 协助设定 target customer：使用者 协助评估：营销/推广需求 协助设定商业目标 2. 运营中心： 网站运营 协助设定产品的 RaodMap 协助设定 target customer：使用者 协助评估：营销/推广需求 协助设定商业目标 3. 客户中心： 客服服务部 讨论客服如何支持：客服需求 协助评估诈欺/数据窜改风险：欺诈 /数据窜改风险、 不当使用风险 预测客服成本、工作量 4. 客户中心： 网络安全部 评估安全性 5. 产品技术中 心：系统分 析
5、师 虚拟团 队 讨论以确定方案的规模评估、推出计划 进行技术可行性分析，提出关键问题的技术解决方案 评估系统规模，数据量，所需资源等 协助评估风险 6. 产品技术中 心：项目经 理 协助确定产品发布日期 协助确定产品成本 协助评估风险 7. 产品技术中 心：用户体 验设计之交 互设计师 协助制作 Demo 协助确定 use flow：用户使用方式 8. 财务分析中 心：财务组 请评估财务需求 协助评估风险 9. 财务分析部： 数据分析组 协助确定如何度量产品目标 10. 行政管理中 心：法务部 协助评估法务问题并检视合作伙伴：使用者数据需求、 法务需求、 版权、隐私权等需求 协助评估风险：诈欺
6、/数据窜改风险、 不当使用风险 11. 规则委员会 协助评估规则变更的影响 12. 支付宝 协助确定接口、合作方式等 13. 阿里软件 协助确定接口、合作方式等 PRD 第 6 页 共 30 页 1 概述 1.1 名词说明 介绍本文档中会使用到的专用名词，如：新名词、产品内实体单位，请尽量使用大众可理 解的名词 名称 说明 开放平台 以开放 OpenAPI 为核心的服务开放系统。包括开放数据、开放平台 和开放的业务方入口。 TOP 全称 : Taobao Open Platform, 淘宝开放平台 App 应用，本文中指由第三方开发的，需要调用淘宝 TOP 来完成业务的 应用程序。通常表现为浏
7、览器端的页面插件，桌面端的应用程序。 ISV Independent Software Vender， 独立软件开发商。 Role 业务方角色，对应于不同的 API 访问权限和监控策略。包括：买家、 卖家、高级卖家等 TPS 每秒业务处理量。 1.2 产品概述及目标 请以三到五段文字摘要说明您所提出的新服务(包含推出新产品、现有产品重新设计或升级、 现有服务推出新功能)及目标；请包括： 1、 产品背景说明； 淘宝开放平台是建立大淘宝的关键要素之一。以围绕淘宝开放数据和业务为核心，把握商 业趋势，以第三方开发软件为助力，建立繁荣的商业生态圈。 对于外部数据的调用和监管，是淘宝开放中最重要的环节之
8、一。同时，在可预见的外部数 据调用大规模增长时，淘宝开放平台也必须拥有适应的机制。这些就是 TIP(淘宝接入平台) 的商业背景和需求。 2、 产品的目标客户； 从 TIP 系统的使用来说，有外部客户和内部用户 PRD 第 7 页 共 30 页 外部用户：第三方开发者通过开发的 App 对 TIP 平台发出数据调用请求。 内部用户：a) 开发者社区。 开发者通过开发者社区系统向 TIP 平台请求相关 App 管 理接口和开发者管理接口。 b) Admin Center。 AdminCenter 使用方为淘宝小二。Admin Center 主要用于管理开放 平台的开发者、App、API；统计分析
9、TOP 数据调用的情况。 1.3 产品 roadmap 请描述产品发展的各个阶段，可以用图表等多种方式表述。 产品发展阶段 阶段描述 时间 1 满足外部数据调用的基本（P1）需求 实现基本的监控、管理功能 对 App 和开发者有最基本的管理，支持 Admin Center 对单个 ISV 单个应用手工纳入 TIP 管理体系。 Admin Center 有基本的 ISV 管理界面，和数据统计 分析 2009 年 3 月 2 完善监控与管理。 （完成相关 P2 需求） 。 完善 App 和开发者管理，支持对批量的 ISV 批量应 用纳入 TIP 管理体系。 建立初步消息通知机制 Admin Cen
10、ter 完善 ISV/App 管理界面，数据统计 支持开发者社区批量接入第三方开发者 2009 年 6 月 3 App 和开发者管理支持第三方草根开发者。 将沙箱环境使用结合进 TIP 的相关申请/管理流程 支持开发者社区对第三方草根开发者的开放。 Admin Center 完成半自动化的管理，集合对淘宝 Hosting 程序的相关支持 2009 年 10 月 1.4 产品风险 请描述产品可能存在的风险，比如商务谈判的风险？外部合作的风险？不当使用的风险 等 等。 风险级别为高中低。 风险 风险级别 描述 监控策略 改善策略 （/ TBD） PRD 第 8 页 共 30 页 2 使用者需求 2
11、.1 需求描述 请说明此产品的目标客户、其需求及使用情境。如已做好 personas(代表性角色描述)，也请 包含于此。 请详细说明此产品主要的使用案例目标客户最想由此产品满足什么需求？最想藉由此产 品解决什么问题？并根据每个不同的使用案例，区别目标客户及其使用时的优先级/重要 性/频率。 目标客户 需求描述 场景描述 优先级 3 可选方案 列出所有可以选择的达到该产品目标的方案要点（主要思路） ，给各方案适当的评价，并推 荐最优方案。 如另有说明可选方案的文档，欢迎使用。 方案介绍 优点 缺点 方案 1 方案 2 方案 3 4 效益成本分析 4.1 效益预测 请提供在各种产品环境中的效益预测
12、，并标明主要的变量及假设，最好能包含现在和过去 的效益数据。 示例： 指标 1 网游每日支付宝成交额 好 中 差 现状 环境 时间 PRD 第 9 页 共 30 页 产品发布 后一周 产品发布 后 3 周 4.2 产品技术中心成本 请列出设计及部署此产品的产品技术中心所需的资源需求，包括人力成本，软硬件支出等。 （项目经理应提供协助） 示例： 人力资源 工作内容描述 成本（人日） 备注 产品经理 交互设计师 开发 测试 非人力资源 成本（元） 描述 硬件投入 软件投入 其他 4.3 非产品技术中心的支持成本 请预估此产品有关的除产品技术部以外的支持投入。 比如：需要客服部投入多少的资源用于该产
13、品的服务，需要运营部投入多少的资源运营该 产品。 示例： 人力资源 工作内容描述 成本（人日） 备注 客服专员 运营专员 非人力资源 成本（元） 描述 广告位 邮件群发 PRD 第 10 页 共 30 页 5 功能需求 请详细说明此产品主要功能及内容(除了使用者所需的功能外，也请说明公司内部操作及维 护产品所需要的功能或工具，例如报表、管理使用者或者维护网站内容的工具、客户服务 工具等等。 5.1 功能总览 请分别列出所有重要的功能及内容模块。 建议使用图表来形象阐述本产品各个组成部分的关系。 功能总表 名称 描述 优先级 备注 1. TIP Router +Gateway 淘宝接入平台网关：
14、 分发外部程序调用淘宝业务数据的请求。 监控、记录和限制外部调用请求 主动通知应用程序信息 1 2. Taobao Intergration Manager 淘宝平台集成管理器： 提供管理开发者接口，用于监控和规范他们 开发行为，并划分等级。 提供管理 App 信息接口，监控和调整 App 使 用状态；与 API 调用或权限控制 提供管理 API 订购状态接口 区分 API 使用角色，和其他 TIP 子系统协作 共同限制业务角色的各种权限。 1 3. TIP Admin Center 淘宝服务调用管理中心： 小二人工管理和调整开发者，API，APP 的 后台工具 展示淘宝各项服务的调用情况的图
15、表报告。 含开发者、API 、APP 等相关数据。 1 Comment K1: App上架流程参考： 1. ISV资格申请 2. 沙箱测试 3. 小二审核 4. 正常发布 Comment K2: 合法状态包括哪几 种 可能考虑： 沙箱阶段 正式使用阶段 PRD 第 11 页 共 30 页 5.2 功能详情 5.1.1TIP服务接入 TIP的服务接入需要处理外部业务数据请求、支持应用能够注册和侦听消息，同时还要进 行业务数据调用的监控，以及对自身性能的监控。 5.1.1.1 业务数据请求 简要说明 验证外部数据请求合法性，再将请求转发给相关 OpenAPI或内部系统。 业务规则 序号 优先级 需
16、求名称 需求描述 1. 1 验证请求合法性 验证 App身份和状态 验证 App是否在 TIM中合法注册 验证 App状态是否是正常使用状态 业务方身份合法性 验证会话 session合法性 本次会话是否真实有效 会话是否过期 传入参数是否有效 验证 App请求是否越权 当前 App请求的 API与其在 TIM中注册的 API权限范围是否相 符 当前 App请求的 API与终端用户在 TIM中注册的角色权限范围 是否相符 验证调用方是否在黑名单中 App是否在黑名单中 域名或 IP地址是否在黑名单中 终端用户是否在黑名单中 2. 四种会话验证机制 根据 App在申请时，申请的 API权限范围和
17、使用描述，第一期由小二决 定 App对应下列那一种应用方式。并和这种方式绑定。 固定时间 SessionKey 当 App应用需要在固定时间内运行时，使用这一种方式授权访问时 间。 根据访问延迟 Sessionkey PRD 第 12 页 共 30 页 界面原型 执行者 应用程序(App) 前置条件 后置条件 主流程 用户在客户端的 App 中登录 根据 App 类型生成相应的 Session 机制 App 从客户端发起数据请求 Gateway 返回 OpenAPI 访问结果 避免用户在短时间内重复登录，影响软件运作和用户体验 两次调用间隔不超过 15 分钟时，自动延长 15 分钟 15 分钟
18、之内，没有有效调用，会话失效 使用一次失效 Sessionkey 单次调用后即失效，如同买家功能中订单确认。每次确认都需要认 证一次。 通知失效 SessionKey 会话一直有效，除非由我们主动终止。场景：一个与淘宝对接的 ERP 系统一直监控订单的状态。 3. 1 业务方身份验证 当所调用请求需要终端用户登录时，调用相关验证程序来验证用户 身份。相关验证程序，在本期表现为： 弹出的一个 域内的浏览器窗口 内含账户名和密码输入框 保证用户输入账户和密码的安全性 4. 1 转发请求 将合法 API 请求转发给相应 OpenAPI 5. 1 返回数据的格式 将 OpenAPI 返回的数据对象按调
19、用方要求的格式返回 支持常用的数据格式 XML JSON 易于扩展成其他数据格式。 PRD 第 13 页 共 30 页 5.1.1.2 消息中心 简要说明 由 Gateway 将相关业务信息，主动通知给业务调用方。如，续费，订单状态改变、暂 停，特殊通知 业务规则 序号 优先级 需求名称 需求描述 1. 2 提供消息通知机制 Gateway 可以通过主动调用 App 回调接口，传输消息中心注册过的消息类 型。 消息中，包括： 消息类型 业务数据： 其余必需数据：时间戳等 典型应用场景： 一个大商家的自动订单处理系统： 一旦用户的某个订单付款了，Gateway 立刻调用自动订单处理系统服务器 的
20、回调接口，发出“已付款”类型消息给它，内含： 消息类型：已付款 业务数据：订单号，订单相关信息 必需数据：时间戳 订单处理系统立刻开始进入后续业务发货流程。 同理，之后，还有“已确认收货”与财务系统的对接，如，划入应收账 款等。 2. 2 消息类型 订单 “等待买家付款” “价格已修改” “买家已付款，等待卖家发货” “卖家已发货，等待买家确认” “订单成功” “订单取消” 商品 上架 下架 售完 库存报警 服务状态 到期，停止服务 服务恢复正常 3. 2 使用消息接口的限 制 由于消息通知机制系统开销成本较高，初期有限制的开放给高级开发者 和特殊大商家角色使用。 对于开发者的限制： PRD
21、第 14 页 共 30 页 界面原型 执行者 前置条件 后置条件 主流程 当 App 注册相关应用侦听时，传入商家号 该商家的订单或者商品变动时，查找需要接受此消息的 App 列表 由 Gateway 按列表逐一调用 App 回调接口 5.1.1.3 监控和性能 简要说明 服务接入过程中，需要实现性能扩展性、子系统独立互不干扰；有效的记录服务接入 情况；监控和管理接入使用。 业务规则 只有 4 星级以上才可以调用接口 对于用户的限制： 买家：高级用户 卖家：高级卖家 4. 2 提供消息注册接口 规范 App 注册侦听某些类型事件(Event)的方法 规范 App 提供的回调接口 5. 2 消息
22、类型注册和撤 销 使用方为淘宝小二和淘宝自己的其他管理程序 消息中心需提供注册新事件的接口，规范事件的数据格式和规范。 消息中心需提供撤销某事件的接口，供取消事件。 序号 优先级 需求名称 需求描述 1. 1 性能 扩展性 由于独立网店的推广，和其他业务推广，在可预计将来 OpenAPI 访 问量的增长将会很迅速。 TIP Gateway 必须具备易于扩展的软硬件结构来适应这种快速增长。 子系统互不干扰 一个子系统的性能或者状态发生变化时，不会影响其余系统 API Comment K3: 由凤先评估 PRD 第 15 页 共 30 页 的正常。 2. 1 日志 记录 OpenAPI调用情况 日
23、志异步记录 至少保留 3个月的记录 记录黑名单、性能监控的相关数据 提供日志相关接口 提供给 Admin Center使用 提供给开发者社区等其他子系统调用（不建议） 日志记录内容： 当前时间 api_key app_path 业务方 id 客户端 IP地址 app请求的 content-type app请求的 body length service名称 (对应的 API名称) uri：包含 path和 method_name，不包含 service_name，如： /list/getMember； service返回的状态码 service返回的 content-type service响应
24、时间 service返回的 body length gateway响应状态码 3. 2 黑名单 设置外部调用的黑名单。一旦调用方落在黑名单中，将失去数据访 问权。 黑名单的分级 暂时失效： 禁止权限 2小时，之后自动从黑名单中消除。 加入和消除时间记录入日志 固定失效：必须调用解禁接口，才会从黑名单中消除 提供黑名单的对外接口 供 Admin Center调用 供其他子系统、其他部门调用 4. 1 性能监控 实时监控(延迟=5 分钟) 每分钟内单个 AppKey或终端用户调用频率明显异常时： 自动加入黑名单，设为“暂时失效” 将相关信息记录入日志 每分钟内部分接口的性能反映异常（错误码） 、挂
25、起时 自动调用 Admin Center相关接口 将相关信息记录入日志 分时段统计监控 PRD 第 16 页 共 30 页 界面原型 执行者 前置条件 后置条件 主流程 5.1.2 Taobao Intergration Manager (淘宝接入管理) 提供管理开发者接口，用于监控和规范他们开发行为，并划分等级。 提供管理 App 信息接口，监控和调整 App 使用状态；与 API 调用或权限控制 提供管理 API 订购状态接口 区分 API 使用角色，和其他 TIP 子系统协作共同限制业务角色的各种权限。 每晚简要分析 TIP 各模块的状态 相关信息记录入日志 5. 2 流量控制 能够根据
26、 APP key 和角色控制单个 API 流量和调用次数。限制形式 如下： 总体限制： 单个 App 在 30 秒内访问 API 次数限制 service 限制： 单个 API 在 30 秒内能被访问的次数限制 按 service+uri 进行限制： 可以对单个 service+uri 进行设置，设置特定的 service+uri 每秒 能被一个 app 访问的次数 按 api_key+service_name 进行限制： 可以按单个 api_key+service_name 进行设置，设置特定的 api_key 对特定的 service_name 每秒能访问的次数 按 api_key+ser
27、vice_name+uri 进行限制： 可以对单个 api_key+service_name+uri 进行设置，设置特定的 api_key 对特定的 service_name 和 uri 每秒能访问的次数 甚至控制，单个 API 对不同角色返回不同结果。 （P2） 应用场景如：淘宝助理的流量不加以控制，但别的就不行。淘宝助 理可以调用批量接口对当前 Sessionkey 中用户商品操作，别的 APP key 不行。 PRD 第 17 页 共 30 页 5.1.2.1 开发者 管理 简要说明 提供管理开发者的各种接口， 业务规则 序号 优先级 需求名称 需求描述 1. 1 需要录入的开发者 信息
28、 在开发者数据库中，所需要记录的开发者相关信息 该开发者的 id 号 常规信息： 联系人姓名 公司 通讯地址： email 账户信息： 收款人，收款人支付宝帐号 对应权限表： 见对应调用权限范围 等级 分成若干级别，供日后运营调用 统计信息 信用记录 应用列表 所拥有的 App 汇总统计数据 历史记录 其他备注 2. 2 开发者 调用权限 范围 记录该开发者可以调用的 OpenAPI 范围 应用场景： 小二从 AdminCenter 中根据开发者的资质来调整他的 API 访问等级和权限。 记录开发者可以注册侦听的 Gateway 事件类型 3. 2 开发者对应等级 每种开发者所可以访问的 AP
29、I 的范围和 API 调用时的控制策略是不 一样的。 PRD 第 18 页 共 30 页 界面原型 无 执行者 外部调用方 前置条件 无 后置条件 无 主流程 无 5.1.2.2 App 管理 简要说明 提供各种 App 信息的对外接口 业务规则 定为 5 个等级：1-5 星级 不同级别，拥有默认的调用权限范围 如果之前权限范围中有超出 等级对应默认范围，按合集处理。 4. 1 开发者 Manager 对 外接口 只提供接口，由其他子系统调用， 如，由小二在 AdminCenter 中调用；开发者社区的相关调用等。 增加开发者接口 删除开发者接口 修改开发者接口 查询开发者接口 序号 优先级
30、需求名称 需求描述 6. 1 App 的数据内容 应用名称 必备接入数据： 应用 Appkey 应用接入方式：代码嵌入/Iframe 框架嵌入/ 客户端 应用类型：旺铺插件/社区插件 /NCP 插件/独立外部插件 应用是否需要绑定用户 Session 基本信息： 应用的图标 分三种图标大小，20X20， 40X40，80X80 应用的简介 应用的详细描述 应用的回调接口地址（如果是 Client 插件，则不需要回调地址） Comment K4: OpenAPi对应的角 色信息。 OpenAPI所对应的 sessionkey是 否需要绑定，和何种类型。 PRD 第 19 页 共 30 页 界面原
31、型 执行者 前置条件 后置条件 主流程 5.1.2.3 API 管理 简要说明 提供各种 App信息的对外接口 业务规则 App key所对应的权限范围表 App对应的状态 统计信息 当前使用数 所拥有的 API调用汇总统计数据 7. 1 App Key对应的权 限范围表 记录该 App可以调用的 OpenAPI范围 记录 App可以注册侦听的 Gateway事件类型 8. 1 App的状态 待审核 审核失败 上架中(暂留) 正在发布过程中 正常使用 暂停使用 9. 1 App Manager 对外接口 只提供接口，由其他子系统调用， 如，由小二在 AdminCenter中调用 增加 App接
32、口 删除 App接口 修改 App接口 查询 App接口 序号 优先级 需求名称 需求描述 10. 2 OpenAPI对应信息 /TBD OpenAPI对应的角色信息 OpenAPI对应的 Sessionkey是否需要绑定，何种类型。 Comment K5: 需要细化到每个接 口上。 PRD 第 20 页 共 30 页 界面原型 执行者 前置条件 后置条件 主流程 5.1.2.4 Role 管理 简要说明 提供各种终端用户角色信息的对外接口 业务规则 11. 2 消息通知 API对应 信息 12. 2 可以设置 OpenAPI 的角色 具体设置 OpenAPI能被哪几种角色可以访问。 角色列表
33、见：5.1.2.4 OpenAPI 序号 优先级 需求名称 需求描述 13. 2 终端用户角色 每个角色对应一组 OpenAPI权限、注册侦听消息权限 角色对应的 App 每个 App中需要的角色由 App来决定。 14. 2 用户角色 买家： 普通买家：没有发生卖出交易的用户 高级买家：可以使用 TIP的消息接口的用户，该类用户数据可以产 生消息发送。 卖家： 普通卖家： 接口使用权限低。 旺铺卖家： 具有 API大部分使用权限，但在产品发布等接口上不具有权限 商城卖家和外部网店卖家： 具有 API所有使用权限 高级卖家： PRD 第 21 页 共 30 页 界面原型 执行者 前置条件 后置
34、条件 主流程 5.2.1 AdminCenter 5.2.1.1 管理开发者的部分 统计需求： 管理需求： 除了具有 API 使用权限外，还可以使用 TIP 消息接口。 淘客： 可以渠道 15. 2 用户角色的绑定 在开发者社区提供专门的角色权限申请页面 在 AdminCenter 中提供“角色权限”勾选范围 1 开发者调用统计 以图表形式表现如下数据 总调用数、频率的日线图 调用的各个接口次数、图表 所有 App 数量统计、 所有开发者的分类统计 序号 优先级 需求名称 需求描述 5. 2 待审核开发者 1、 列表显示字段有：开发者的类别、联系姓名、电子邮件地址、网址、 联系电话、已通过的角
35、色。 2、 可做的操作有：通过、拒绝 a) 通过后则待审用户自动进入下一个角色的待审列表中。 b) 拒绝则需要输入拒绝理由。 审核机制采取一票否决制。 Comment K6: 校验 App对应的角 色 PRD 第 22 页 共 30 页 界面原型 执行者 开发者 前置条件 登录进入开发者社区，进入管理中心 后置条件 无 主流程 5.2.1.2 管理 App的部分 简要说明 数据中心，存储 App（应用）和开发者相关 信息。 业务规则 统计需求 6. 2 已通过开发者 1、 列表显示字段有：开发者的类别、联系姓名、电子邮件地址、网址、 联系电话，开发者注册的应用（点击后可以查看应用的详细资料）
36、。 可做操作有：删除 7. 2 删除开发者 1、 被删除的开发者如没有注册应用，则输入完删除理由后从列表中消失。 被删除的开发者如有注册应用，输入删除理由后，该开发者所属应用也 全部被删除，已使用该应用的模块也相应被删除。 序号 优先级 需求名称 需求描述 8. 2 开发者列表 1、 以表格方式列出所有开发者。 2、 显示字段为开发者类别/姓名 /电邮/应用数目（已通过/未通过） （/TBD） 1 App应用统计 以图表形式表现如下数据 注册数统计 App单个调用数统计、列表 分类统计 趋势统计 序号 优先级 需求名称 需求描述 PRD 第 23 页 共 30 页 1. 1 添加新的应用 1、
37、 需要填写的字段为： 应用名称 必备接入数据： 应用 Appkey 应用接入方式：代码嵌入/Iframe 框架嵌入/ 客户端 应用类型：旺铺插件/社区插件 /NCP 插件/独立外部插件 应用是否需要绑定用户 Session 基本信息： 应用的图标 分三种图标大小，20X20， 40X40，80X80 应用的简介 应用的详细描述 应用的回调接口地址（如果是 Client 插件，则不需要回调地址） 2、 提交后的提示信息中给出 api_key，并再次判断用户是否有站点，如 无站点提示同注册开发者时相同。 注册成功后，该应用信息进入调试状态。 2. 1 应用详细资料页 显示应用的详细信息，显示的内容
38、为添加应用时填写的内容以及被使用 次数、评论。 PRD 第 24 页 共 30 页 序号 优先级 需求名称 需求描述 1. 2. 2 修改应用 1、 已上线的应用可修改 a) 可修改所有字段 b) 修改后，用户可以选择发布到调试环境或者是发布到正式环境， 发布到调试环境的线上应用，在调试环境中可以添加和使用， 并不替换线上应用。 c) 选择发布到正式环境后修改后的信息进入审核系统，并不替换 线上应用信息。 2、 审核中的新应用修改不允许修改。 修改通过后的应用对老模块升级。 3. 2 下线应用 1、 已上线的应用开发者可以修改为下线状态，审核流程如同修改 3、 被批准的下线应用将从列表中消失，
39、且不能被添加，但原添加的模块 可继续使用。 4. 2 删除应用 1、 删除上线状态的应用：提出申请后进入审核流程，审核通过后凡是使 用到该应用的模块一并被删除。 5. 2 下线应用 2、 已上线的应用开发者可以修改为下线状态，审核流程如同修改 4、 被批准的下线应用将从列表中消失，且不能被添加，但原添加的模块 可继续使用。 6. 2 下线应用 3、 已上线的应用开发者可以修改为下线状态，审核流程如同修改 5、 被批准的下线应用将从列表中消失，且不能被添加，但原添加的模块 可继续使用。 序号 优先级 需求名称 需求描述 PRD 第 25 页 共 30 页 9. 2 应用列表 1、 应用列表根据应
40、用的状态分为以下几个 tab：已发布、调试中、审核 中、被拒绝、下线、删除。 2、 已发布状态的应用为已经通过审核，线上正在使用中的应用。 a) 显示字段为：icon、名称、上线时间、类别、类型、被使用次数、 查看评论。 b) 点击 icon 或名称可以查看应用详细资料。 c) 可做的操作有：修改、删除。 3、 调试中的应用为调试环境下才能添加和使用的应用，线上环境并不能 看到和被添加。 a) 显示的字段为：icon、名称、提交时间、类别、类型。 b) 点击 icon 或名称可以查看应用详细资料。 c) 可做的操作有：修改、发布、删除。 4、 审核中状态的应用为新应用或修改后提交审核的应用，目
41、前处于开发 环境中。 a) 显示字段为：icon、名称、提交审核时间、类别、类型、状态 （新应用还是老应用修改后待审） 。 b) 点击 icon 或名称可以查看应用详细资料。 c) 可做操作有：修改、删除。 d) 5、 被拒绝状态的应用为新应用或修改后提交审核的应用被淘宝审核人员 拒绝的应用。 a) 显示字段为：icon、名称、被拒绝时间、类别、类型、状态（新 应用还是老应用修改后待审） 、查看拒绝理由 b) 点击 icon 或名称可以查看应用详细资料。 c) 新应用被拒绝后可做的操作有：修改、删除。点击修改后流程 同添加新应用；点击删除后，该应用的信息从列表中消失。 d) 老应用修改被拒绝后
42、无可作操作。 6、 下线状态的应用为老应用被开发者或淘宝审核者作出下线操作的应用， 该类应用将不会在列表中出现，且不能被添加，但已使用中的不受影 响。 a) 显示字段为：icon、名称、上线时间、下线时间、类别、类型、 被使用次数、查看评论。 b) 点击 icon 或名称可以查看应用详细资料。 c) 可做的操作有：修改、删除。 7、 删除状态的应用为被删除的老应用，包括开发者自己删除和淘宝审核 删除。 a) 显示字段为：icon、名称、上线时间、删除时间、类别、类型、 PRD 第 26 页 共 30 页 界面原型 执行者 前置条件 后置条件 主流程 5.2.1.3 管理 API 的部分 简要说
43、明 业务规则 被使用次数、查看评论、删除理由、删除者的角色。 b) 点击 icon 或名称可以查看应用详细资料。 无任何可做的操作，仅仅是一个信息记录。 10. PRD 第 27 页 共 30 页 界面原型 执行者 前置条件 后置条件 主流程 5.3 整合需求 请详细说明此产品可与其它产品或公司的整合需求。 (详细的功能应在功能详情 中说明) 序号 优先级 需求名称 需求描述 16. 1 OpenAPI 各项指标 统计 API 接口调用次数统计 所耗性能 被调用的 APP 数目 17. 2 单个 OpenAPI 的信 息 名称 状态 所属角色权限 18. 1 OpenAPI 列表 列出当前所有
44、 OpenAPI 信息： 名称 状态 19. 2 暂停服务 暂停服务包括整体 OpenAPI 的暂停和选定 API 接口的暂停。 总体限制：暂停单个 App 访问 API service 限制： 单个 API 在 30 秒内能被访问的 API 按 service+uri 进行限制： 可以对单个 service+uri 进行设置，限制访问 按 api_key+service_name 进行限制： 可以按单个 api_key+service_name 进行设置，设置特定的 api_key 对特定的 service_name 限制访问 按 api_key+service_name+uri 进行限制：
45、 20. 2 更改 OpenAPI 对应 角色 更改对应角色权限。 PRD 第 28 页 共 30 页 产品/合作公司 描述 基本需求 优先级 5.4 BETA 测试需求 请说明是否需要 BETA 测试，BETA 测试的要求及期望达到的目标。 6 非功能需求 产品营销需求 如果此产品有推广需求和推广资源，请说明使用的推广方式、目标受众以及是否有限制或 特殊要求？ (网站运营部应提供主要内容。 范例： 推广方式 受众 描述说明 站内信通知 卖家 规则变更需求 本产品可能涉及到的对淘宝规则的变更。 （(规则委员会应提供主要内容。 产品服务需求 产品上线是否需要客服协助？此产品计划的服务优先级和重要
46、性如何？当此产品上线后， 你想要从客服中得到什么信息？(例如，关于此产品，请根据产品相关数据进行推断，客服 每周处理多少客诉？花多少时间回复 e-mail？会员常问的问题是什么？) 客服应如何支持？ 对客服有何影响？客服最常遇到什么状况？应如何回应？此产品尚未上线前或上线时，客 服可或不可与客户沟通，沟通什么？(请与客户服务部和技术支持讨论确定) 范例：服务类型 是否为 新服务 预计服务事件 预计频率 场景描述 服务解决方案 PRD 第 29 页 共 30 页 评价被删除 的 咨询 1000 个/ 天 1、为缓解服务压力，项目采取逐步推进方式， 先自动删除 99%以上概率为信用炒作的评价， 然
47、后逐步降低概率； 2、面对咨询，为客服提供以下功能： 1）后台评价单向删除； 2）后台评价双向删除 3、在知识库、帮助中心添加相关内容； 4、在客服中组织培训； 法务需求 请详细说明与隐私权、知识产权、专利权、商标、服务条款(TOS)、版权、合同责任、客户 沟通等相关之法务议题或需求。(法务应提供协助) 财务需求 此产品是否有特殊的会计财务需求，如有请详细说明。(财务部应提供协助) 帮助需求 请提供内部使用者或者客户在使用此产品时所需要的任何说明文件或帮助，比如线上帮助、 CRM 知识库、FAQ 等。 安全性需求 产品需符合网络安全部的相关规定； 7 上、下线需求 7.1 上线时限需求 此产品预定上线日期？上线日期有无任何特殊依据或规定？ 7.2 下线需求（活动类需求必须明确下线时间） 此产品预定下线日期？下线日期有无任何特殊依据或规定？ PRD 第 30 页 共 30 页 8 运营计划 请说明产品的后续运营计划。
