1 / 11
文档名称:

接口设计规范V1.0---参考.doc

格式:doc   大小:172KB   页数:11页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

接口设计规范V1.0---参考.doc

上传人:yzhlyb 2019/9/6 文件大小:172 KB

下载得到文件列表

接口设计规范V1.0---参考.doc

文档介绍

文档介绍:---参考服务端与手机平台接口协议BespRout2014年11月文档修改/审批记录版本号修改人/审批人修改/-11--11--11--11-24更换前缀+-4-、、、、,-5-,、、、-5-(添加相关的响应参数),-8-,-8-、-12-、. 概述 42. 涉及接口 43. 接口总体要求 . 系统间接口的原则 . 处理流程 . 接口实现方式 54. XXX服务端接口 . XX模块-根据XX下载相关的配置文件 . XX模块-生成指定XX的文件配置 . APP启动-初使化参数 75. 附件 . 备注说明 8概述本文档提供接口给手机端使用,为手机端提供业务平台数据涉及接口本文档涉及的外围系统接口包括:无接口总体要求系统间接口的原则接口设计遵循如下原则:安全可靠性原则:系统应提供良好的安全性和可靠性策略,支持多种安全而可靠的技术手段,制定严格的安全可靠的管理措施;开放性原则:提供开放式标准接口,提供与其它系统的互联互通;灵活性原则:提供灵活的接口设计,便于接口的变动。可扩展性原则:支持新业务的扩展以及接口容量与接口性能的提高;可管理性原则:提供良好的管理机制,保证在运行过程中提供给管理员方便的管理方式以处理各种情况;统一性原则:应当保证系统的接口方式、接口形式、使用的协议等标准、统一。处理流程接口处理流程接口实现方式手机APP应用与服务端采用基于HTTP的REST协议完成,数据传输默认为JSON请求消息JSON(详细见下面各列表)应答消息json(JSON格式)接口协议http(rest协议)接口实现者Mascar_qis服务端主要使用者手机APP(android&iphone)XXX服务端接口测试地址前缀::8088/xxx/xxxXX模块-根据XX下载相关的配置文件接口名称下载相关的配置文件接口描述根据厂商ID下载相关的配置文件测试地址前缀+/file/download/{storeId}?token=token参数详见配置请求方式GET正式地址待定参数请求体参数参数含义类型长度必填说明patform平台String20必填值为iphone或者android响应体无XX模块-生成指定XX的文件配置接口名称生成指定商家的文件配置接口描述根据厂商ID,生成指定商家的文件配置测试地址前缀+/file/generate/{storeId}?token=token参数详见配置请求方式GET正式地址待定参数请求体无响应体参数参数含义数据类型说明respCode标识是否操作成功String0成功1失败respDesc当标识respCode为1时候显示错误信息StringAPP启动-初使化参数接口名称初使化参数接口接口描述初使化参数接口测试地址前缀+/brands/param/list?token=token参数详见配置请求方式GET正式地址待定请求参数无响应体参数参数含义数据类型说明respCode标识是否操作成功String0成功1失败respDesc当标识respCode为1时候显示错误信息StringshareFacebookUrlfb分享的地址StringshareFacebookKeyStringshareFacebookSecretStringshareFacebookInfofb分享的内容Stringshare***Urltw分享的地址Stringshare***KeyStringshare***SecretStringshare***Infotw分享的内容StringshareEmailStringshareEmailTitleemail分享的标题StringmaxNumOfFamilyMember最多允许加入的家庭成员的个数StringguidingTextOfHBCHBC引导文字StringhelpTextOfHBCHBC帮助文字StringpayType支付类型String1