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

1、服务端与手机平台服务端与手机平台服务端与手机平台接口协议接口协议接口协议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、

2、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. 涉及接口

3、.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. 系统间接口的原则接口设计遵循如下原则： 安全可靠性原则

4、：系统应提供良好的安全性和可靠性策略，支持多种安全而可靠的技术手段，制定严格的安全可靠的管理措施； 开放性原则：提供开放式标准接口，提供与其它系统的互联互通； 灵活性原则：提供灵活的接口设计，便于接口的变动。 可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； 可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便的管理方式以处理各种情况； 统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统一。3.2. 处理流程接口处理流程服务端与手机通信接口规范福建 XXX 科技有限公司 第 5 页/共 9 页a n d r o i d 手机 i p h o n e 手

5、机 http请求http请求。3.3. 接口实现方式手机 APP 应用 与服务端采用基于 HTTP 的 REST 协议完成，数据传输默认为JSON请求消息 JSON（详细见下面各列表)应答消息 json (JSON 格式 )接口协议 http（rest 协议）接口实现者Mascar_qis 服务端主要使用者手机 APP（android&iphone）4. XXX 服务端接口测试地址前缀: http:/192.168.3.208:8088/xxx/xxx4.1. XX 模块-根据 XX 下载相关的配置文件接口名称 下载相关的配置文件接口描述 根据厂商 ID 下载相关的配置文件测试地址 前缀+/f

6、ile/download/storeId?token=服务端与手机通信接口规范福建 XXX 科技有限公司 第 6 页/共 9 页token 参数详见配置请求方式 GET正式地址 待定参数请求体参数 参数含义 类型 长度 必填 说明patform 平台 String 20 必填 值为 iphone 或者 android响应体无4.2. XX 模块-生成指定 XX 的文件配置接口名称 生成指定商家的文件配置接口描述 根据厂商 ID，生成指定商家的文件配置测试地址 前缀+/file/generate/storeId?token=token 参数详见配置请求方式 GET正式地址 待定参数请求体无响应体

7、参数 参数含义 数据类型 说明respCode 标识是否操作成功 String 0 成功 1 失败respDesc当标识 respCode 为 1时候显示错误信息String服务端与手机通信接口规范福建 XXX 科技有限公司 第 7 页/共 9 页4.3. APP 启动-初使化参数接口名称 初使化参数接口接口描述 初使化参数接口测试地址 前缀+/brands/param/list?token =token 参数详见配置请求方式 GET正式地址 待定请求参数无响应体参数 参数含义 数据类型说明respCode 标识是否操作成功 String0 成功 1 失败respDesc当标识 respCod

8、e 为 1 时候显示错误信息StringshareFacebookUrl fb 分享的地址 StringshareFacebookKey StringshareFacebookSecret StringshareFacebookInfo fb 分享的内容 StringshareTwitterUrl tw 分享的地址 StringshareTwitterKey StringshareTwitterSecret StringshareTwitterInfo tw 分享的内容 StringshareEmail String服务端与手机通信接口规范福建 XXX 科技有限公司 第 8 页/共 9 页sh

9、areEmailTitle email 分享的标题 StringmaxNumOfFamilyMember最多允许加入的家庭成员的个数StringguidingTextOfHBC HBC 引导文字 StringhelpTextOfHBC HBC 帮助文字 StringpayType 支付类型 String 1-A,2-TrustCommerce,3-ProPay注：以上所有内容需先 Base64 解，再 DES 解才可得到定义的内容5. 附件5.1. 备注说明token 算法生成 说明：加密方式：手机与服务端各持有密钥 Key，密钥暂定为 XXXX。token= Base64（“time=&nu

10、m=&accessToken=&version=&appId=&brandId=& platform=& phoneUUID=”）Key 值 说明time 当前时间的 long 值num 5 位数字和字母的随机字符串accessToken Des(Key, “time_ num”)appId 后台分配的用户 Id调用注册或者没有 id 直接使用 init服务端与手机通信接口规范福建 XXX 科技有限公司 第 9 页/共 9 页version App 当前版本号brandId 后台分配的品牌 Idplatform 平台类型：iphone/iphoneLiteandroid/androidLitephoneUUID 安装软件后唯一标识 64UUID开发过程中，可以先传一个固定 token：xxx备注：respCode 标识是否操作成功 String0 成功1 失败2 用户其他手机登录3 用户登录后，被锁。respDesc当标识 respCode 为 1 时候显示错误信息String如果 2 或者 3 需要强行弹框，点击后直接退出到登录界面。1 视业务逻辑，选择是否强框