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

服服服务务务端端端与与与手手手机机机平平平台台台接接接口口口协协协议议议BespRout2014年11月服务端与手机通信接口规范福建XXX科技有限公司第2页/共9页文档修改/审批记录版本号修改人/审批人修改/审批日期修改内容备注V1.0林成民2014-11-12创建V1.0林成民2014-11-19添加商家和品牌相关等的接口V1.0林成民2014-11-21添加Ordering相关等接口V1.0吴秋锦2014-11-24更换前缀+coupon接口V1.0林成民2015-4-28修改4.61、4.64、4.47、4.49、4.50接口，并且添加4.86接口V1.0林成民2015-5-18修改4.66接口的参数说明，新增4.87、4.88、4.89、4.90接口V1.0林成民2015-5-27修改4.90接口（添加相关的响应参数），添加新接口4.91V1.0林成民2015-8-06修改4.64，添加是否显示同步用户信息按钮V1.0林成民2015-8-12修改4.49、4.50接口V1.0林成民2015-12-14修改4.3、4.68接口服务端与手机通信接口规范福建XXX科技有限公司第3页/共9页目录1.概述.....................................................................................................................42.涉及接口.............................................................................................................43.接口总体要求.....................................................................................................43.1.系统间接口的原则......................................................................................43.2.处理流程......................................................................................................43.3.接口实现方式..............................................................................................54.XXX服务端接口...............................................................................................54.1.XX模块-根据XX下载相关的配置文件..................................................54.2.XX模块-生成指定XX的文件配置..........................................................64.3.APP启动-初使化参数................................................................................75.附件.....................................................................................................................85.1.备注说明......................................................................................................8服务端与手机通信接口规范福建XXX科技有限公司第4页/共9页1.概述本文档提供接口给手机端使用，为手机端提供业务平台数据2.涉及接口本文档涉及的外围系统接口包括：无3.接口总体要求3.1.系统间接口的原则接口设计遵循如下原则：安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而可靠的技术手段，制定严格的安全可靠的管理措施；开放性原则：提供开放式标准接口，提供与其它系统的互联互通；灵活性原则：提供灵活的接口设计，便于接口的变动。可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高；可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便的管理方式以处理各种情况；统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统一。3.2.处理流程接口处理流程服务端与手机通信接口规范福建XXX科技有限公司第5页/共9页android手机iphone手机http请求http请求。。。。。。3.3.接口实现方式手机APP应用与服务端采用基于HTTP的REST协议完成，数据传输默认为JSON请求消息JSON（详细见下面各列表)应答消息json(JSON格式)接口协议http（rest协议）接口实现者Mascar_qis服务端主要使用者手机APP（android&iphone）4.XXX服务端接口测试地址前缀:模块-根据XX下载相关的配置文件接口名称下载相关的配置文件接口描述根据厂商ID下载相关的配置文件测试地址前缀+/file/download/{storeId}?token=token参数详见配置服务端与手机通信接口规范福建XXX科技有限公司第6页/共9页请求方式GET正式地址待定参数请求体参数参数含义类型长度必填说明patform平台String20必填值为iphone或者android响应体无4.2.XX模块-生成指定XX的文件配置接口名称生成指定商家的文件配置接口描述根据厂商ID，生成指定商家的文件配置测试地址前缀+/file/generate/{storeId}?token=token参数详见配置请求方式GET正式地址待定参数请求体无响应体参数参数含义数据类型说明respCode标识是否操作成功String0成功1失败respDesc当标识respCode为1时候显示错误信息String服务端与手机通信接口规范福建XXX科技有限公司第7页/共9页4.3.APP启动-初使化参数接口名称初使化参数接口接口描述初使化参数接口测试地址前缀+/brands/param/list?token=token参数详见配置请求方式GET正式地址待定请求参数无响应体参数参数含义数据类型说明respCode标识是否操作成功String0成功1失败respDesc当标识respCode为1时候显示错误信息StringshareFacebookUrlfb分享的地址StringshareFacebookKeyStringshareFacebookSecretStringshareFacebookInfofb分享的内容StringshareTwitterUrltw分享的地址StringshareTwitterKeyStringshareTwitterSecretStringshareTwitterInfotw分享的内容StringshareEmailStringshareEmailTitleemail分享的标题String服务端与手机通信接口规范福建XXX科技有限公司第8页/共9页maxNumOfFamilyMember最多允许加入的家庭成员的个数StringguidingTextOfHBCHBC引导文字StringhelpTextOfHBCHBC帮助文字StringpayType支付类型String1-Authorize.net,2-TrustCommerce,3-ProPay注：以上所有内容需先Base64解，再DES解才可得到定义的内容5.附件5.1.备注说明token算法生成说明：加密方式：手机与服务端各持有密钥Key，密钥暂定为XXXX。token=Base64（“time=&num=&accessToken=&version=&appId=&brandId=&platform=&phoneUUID=”）Key值说明time当前时间的long值num5位数字和字母的随机字符串accessTokenDes(Key,“time_num”)appId后台分配的用户Id调用注册或者没有id直接使用initversionApp当前版本号brandId后台分配的品牌Idplatform平台类型：服务端与手机通信接口规范福建XXX科技有限公司第9页/共9页iphone/iphoneLiteandroid/androidLitephoneUUID安装软件后唯一标识64UUID开发过程中，可以先传一个固定token：xxx备注：respCode标识是否操作成功String0成功1失败2用户其他手机登录3用户登录后，被锁。respDesc当标识respCode为1时候显示错误信息String如果2或者3需要强行弹框，点击后直接退出到登录界面。1视业务逻辑，选择是否强框