个人代理人手机客户端接口设计文档20110120.doc

个人代理人手机客户端 编写时间： 2011-01-04  修订控制页 编号 文档版本 修订章节 修订原因 修订日期 修订人 1 V1.0 全部 新增 2011-01-04 李来普 2 V1.1 保费计算接口修改 主要由客户端实现简版 2011-01-10 李来普 3 V1.2 请求参数修改 加入数据格式类型参数 2011-01-17 李来普 4 5 6 7 8 9 10 1概述 1.1概述及目标 根据个人代理人手机客户端软件功能需求方案完成手机客户端所需的服务端接口定义设计。同时根据产品需求设计方案调整修改接口定义。 1.2接口风险 请描述接口实现可能存在的风险，比如技术无法实现的风险？沟通合作的风险？外部接口无法提供的风险等等。 风险级别为高中低。 风险 风险级别 描述 监控策略 改善策略 1 高 原来系统接口人配合程度及系统了解程度 无 2 高 原来系统代码库接口及文档不存在，进展困难 及时跟进 进一步完成 2. 中 整体工作量的评估 进一步完成 2接口规范协议 2.1请求方式 为了减少服务端与手机端的交互程度，减轻服务端压力，为用户节省流量，并同时提高用户交互体验。采用在登录时或手动触发批量数据请求同步。手机端自行存储同步后的数据。当数据同步完成后，用户打开功能模块时，调用本地数据进行展示。对于即时或算法要求较高的模块则采用即时调用后台数据。 2.2请求参数 采用标准HTTP方式GET或POST进行请求。服务端与Web请求类似。自动取得参数进行解析。 2.3 返回数据格式 为了兼容多种终端系统平台，采用XML通用格式进行返回结果。手机端自行解析并转换成可识别的数据。 3接口设计 3.1用户登录接口设计 登录[remoteLogin:Service] 描述 对外提供统一用户登录接口，通过HTTP协议验证用户名密码。 http://host:port/user/remoteLogin.do 请求参数列表 Required Name Type Description required username string 登录的用户名 password string 登录密码 optional datatype string 数据格式类型(取值：json,xml 默认xml格式) 返回参数列表 Name Type Description success boolean 成功标识 errorMsg string 错误消息 userId string 用户Id(32位主键) 返回xml数据示例 result successtrue/success userId00000000000000000000000000008549/userId errorMsg/errorMsg /result 3.2保单跟进同步接口设计 保单跟进列表[policyFollowList:Service] 描述 提示当前代理人所有状态发生改变的保单列表。 http://host:port/policy/policyFollowList.do 请求参数列表 Required Name Type Description required userId string 用户Id start int 开始记录数 limit int 要取得记录数 optional datatype string 数据格式类型(取值：json,xml 默认xml格式) 返回参数列表 Name Type Description total int 更新记录总数 list List 保单列表，包含保单对象 保单对象 Name Type Description plyNo string 对应编号 variety string 保险品种 type string 保险类别 status string 保单状态 返回参数样例 result total6/total list policy plyNplyNo !-对应编号-- variety07机动车商业险/variety !-保险品种-- type汽车险/type !-保险类别-- status1/status !-保单状态-- /policy /list /result 保单基本情况[policyInfo:Service] 描述 根据保单号取出保单基本情况。 http://host:port/policy/po