接口设计规范V1.0---参考
文档修改/审批记录
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-1
2-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.系统间接口的原则
接口设计遵循如下原则：
⏹安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而
可靠的技术手段，制定严格的安全可靠的管理措施；
⏹开放性原则：提供开放式标准接口，提供与其它系统的互联互通；
⏹灵活性原则：提供灵活的接口设计，便于接口的变动。
⏹可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高；
⏹可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便
的管理方式以处理各种情况；
⏹统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统
一。
3.2.处理流程
接口处理流程
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
maxNumOfFamilyM ember 最多允许加入的家庭成员的个
数
String
guidingTextOfHBC HBC引导文字String helpTextOfHBC HBC帮助文字String
payType 支付类型String 1-Authorize.
net,2-TrustC
ommerce,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 平台类型：
