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

服务端与手机通信接口规范

服务端与手机平台
接口协议

BespRout
2014年11月

文档修改/审批记录
版本号
修改人/审批人
修改/审批日期
修改内容
备注
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.91

V1.0
林成民
2015-8-06
修改 4.64，添加是否显示同步用户信息按钮

V1.0
林成民
2015-8-12
修改 4.49、4.50接口

V1.0
林成民
2015-12-14
修改 4.3、 4.68接口

目 录

1. 概述 4
2. 涉及接口 4
3. 接口总体要求 4
3.1. 系统间接口的原则 4
3.2. 处理流程 4
3.3. 接口实现方式 5
4. XXX服务端接口 5
4.1. XX模块-根据XX下载相关的配置文件 5
4.2. XX模块-生成指定XX的文件配置 6
4.3. APP启动-初使化参数 7
5. 附件 8
5.1. 备注说明 8

1. 概述
本文档提供接口给手机端 使用，为手机端提供业务平台数据
2. 涉及接口
本文档涉及的外围系统接口包括：无
3. 接口总体要求
3.1. 系统间接口的原则
接口设计遵循如下原则：
n 安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而可靠的技术手段，制定严格的安全可靠的管理措施；
n 开放性原则：提供开放式标准接口，提供与其它系统的互联互通；
n 灵活性原则：提供灵活的接口设计，便于接口的变动。
n 可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高；
n 可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便的管理方式以处理各种情况；
n 统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统一。

3.2. 处理流程
接口处理流程

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/xxx
4.1. XX模块-根据XX下载相关的配置文件
接口名称
下载相关的配置文件
接口描述
根据厂商ID下载相关的配置文件
测试地址
前缀+/file/download/{storeId}?token=
token参数详见配置
请求方式
GET
正式地址
待定

参数请求体
参数
参数含义
类型
长度
必填
说明
patform
平台
String
20
必填
值为iphone或者android

响应体
无
4.2. XX模块-生成指定XX的文件配置
接口名称
生成指定商家的文件配置
接口描述
根据厂商ID，生成指定商家的文件配置
测试地址
前缀+/file/generate/{storeId}?token=
token参数详见配置
请求方式
GET
正式地址
待定

参数请求体
无
响应体
参数
参数含义
数据类型
说明
respCode
标识是否操作成功
String
0成功1失败
respDesc
当标识respCode为1时候显示错误信息
String

4.3. APP启动-初使化参数
接口名称
初使化参数接口
接口描述
初使化参数接口
测试地址
前缀+/brands/param/list?token=
token参数详见配置
请求方式
GET
正式地址
待定
请求参数
无

响应体
参数
参数含义
数据类型
说明
respCode
标识是否操作成功
String
0成功1失败
respDesc
当标识respCode为1时候显示错误信息
String

shareFacebookUrl
fb分享的地址
String

shareFacebookKey

String

shareFacebookSecret

String

shareFacebookInfo
fb分享的内容
String

shareTwitterUrl
tw分享的地址
String

shareTwitterKey

String

shareTwitterSecret

String

shareTwitterInfo
tw分享的内容
String

shareEmail

String

shareEmailTitle
email分享的标题
String

maxNumOfFamilyMember
最多允许加入的家庭成员的个数
String

guidingTextOfHBC
HBC引导文字
String

helpTextOfHBC
HBC帮助文字
String

payType
支付类型
String
1-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值
num
5位数字和字母的随机字符串
accessToken
Des(Key, “time_ num”)
appId
后台分配的用户Id
调用注册或者没有id直接使用init
version
App当前版本号
brandId
后台分配的品牌Id
platform
平台类型：
iphone/iphoneLite
android/androidLite
phoneUUID
安装软件后唯一标识64UUID

开发过程中，可以先传一个固定token：
xxx

备注：
respCode
标识是否操作成功
String
0成功
1失败
2 用户其他手机登录
3 用户登录后，被锁。
respDesc
当标识respCode为1时候显示错误信息
String

如果2 或者3需要强行弹框，点击后直接退出到登录界面。
1视业务逻辑，选择是否强框

福建XXX科技有限公司 第9页/共9页