接口设计标准规范V参考.doc

服务端和手机平台接口协议BespRout 11月文档修改/审批统计版本号修改人/审批人修改/审批日期修改内容备注V1.0林成民-11-12创建V1.0林成民-11-19添加商家和品牌相关等接口V1.0林成民-11-21添加Ordering相关等接口V1.0吴秋锦-11-24更换前缀+coupon接口V1.0林成民-4-28修改 4.61、 4.64、 4.47、 4.49、 4.50接口，而且添加4.86接口V1.0林成民-5-18修改 4.66接口参数说明，新增 4.87、 4.88、 4.89、 4.90接口V1.0林成民-5-27修改4.90接口（添加相关响应参数），添加新接口4.91V1.0林成民-8-06修改 4.64，添加是否显示同时用户信息按钮V1.0林成民-8-12修改 4.49、4.50接口V1.0林成民-12-14修改 4.3、 4.68接口目 录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.备注说明81. 概述 本文档提供接口给手机端 使用，为手机端提供业务平台数据2. 包含接口本文档包含外围系统接口包含：无3. 接口总体要求3.1. 系统间接口标准接口设计遵照以下标准：n 安全可靠性标准：系统应提供良好安全性和可靠性策略，支持多个安全而可靠技术手段，制订严格安全可靠管理方法；n 开放性标准：提供开放式标准接口，提供和其它系统互联互通；n 灵活性标准：提供灵活接口设计，便于接口变动。n 可扩展性标准：支持新业务扩展和接口容量和接口性能提升；n 可管理性标准：提供良好管理机制，确保在运行过程中提供给管理员方便管理方法以处理多种情况；n 统一性标准：应该确保系统接口方法、接口形式、使用协议等标准、统一。3.2. 处理步骤接口处理步骤3.3. 接口实现方法手机APP应用 和服务端采取基于HTTPREST协议完成，数据传输默认为JSON请求消息JSON（具体见下面各列表)应答消息json (JSON格式)接口协议http（rest协议）接口实现者Mascar_qis 服务端关键使用者手机APP（android&iphone）4. XXX服务端接口测试地址前缀: :8088/xxx/xxx4.1. XX模块-依据XX下载相关配置文件接口名称下载相关配置文件接口描述依据厂商ID下载相关配置文件测试地址前缀+/file/download/storeId?token=token参数详见配置请求方法GET正式地址待定参数请求体参数参数含义类型长度必填说明patform平台String20必填值为iphone或android响应体无4.2. XX模块-生成指定XX文件配置接口名称生成指定商家文件配置接口描述依据厂商ID，生成指定商家文件配置测试地址前缀+/file/generate/storeId?token=token参数详见配置请求方法GET正式地址待定参数请求体无响应体参数参数含义数据类型说明respCode标识是否操作成功String0成功1失败respDesc当标识respCode为1时候显示错误信息String4.3. APP开启-初使化参数接口名称初使化参数接口接口描述初使化参数接口测试地址前缀+/brands/param/list?token=token参数详见配置请求方法GET正式地址待定请求参数 无响应体参数参数含义数据类型说明respCode标识是否操作成功String0成功1失败respDesc当标识respCode为1时候显示错误信息StringshareFacebookUrlfb分享地址StringshareFacebookKeyStringshareFacebookSecretStringshareFacebookInfofb分享内容StringshareTwitterUrltw分享地址StringshareTwitterKeyStringshareTwitterSecretStringshareTwitterInfotw分享内容StringshareEmailStringshareEmailTitleemail分享标题StringmaxNumOfFamilyMember最多许可加入家庭组员个数StringguidingTextOfHBCHBC引导文字StringhelpTextOfHBCHBC帮助文字StringpayType支付类型String1-A,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平台类型：iphone/iphoneLiteandroid/androidLitephoneUUID安装软件后唯一标识64UUID开发过程中，能够先传一个固定token：xxx备注：respCode标识是否操作成功String0成功1失败2 用户其它手机登录3 用户登录后，被锁。respDesc当标识respCode为1时候显示错误信息String假如2 或3需要强行弹框，点击后直接退出到登录界面。1视业务逻辑，选择是否强框