接口设计规范V10参考Word下载.docx

接口设计规范V10参考Word下载.docx

《接口设计规范V10参考Word下载.docx》由会员分享，可在线阅读，更多相关《接口设计规范V10参考Word下载.docx（8页珍藏版）》请在冰豆网上搜索。

2014-11-21

添加Ordering相关等接口

吴秋锦

2014-11-24

更换前缀+coupon接口

2015-4-28

修改4.61、4.64、4.47、4.49、4.50接口，并且添加4.86接口

2015-5-18

修改4.66接口的参数说明，新增4.87、4.88、4.89、4.90接口

2015-5-27

修改4.90接口（添加相关的响应参数），添加新接口4.91

2015-8-06

修改4.64，添加是否显示同步用户信息按钮

2015-8-12

修改4.49、4.50接口

2015-12-14

修改4.3、4.68接口

1.概述

本文档提供接口给手机端使用，为手机端提供业务平台数据

2.涉及接口

本文档涉及的外围系统接口包括：

无

3.接口总体要求

3.1.系统间接口的原则

接口设计遵循如下原则：

⏹安全可靠性原则：

系统应提供良好的安全性和可靠性策略，支持多种安全而可靠的技术手段，制定严格的安全可靠的管理措施；

⏹开放性原则：

提供开放式标准接口，提供与其它系统的互联互通；

⏹灵活性原则：

提供灵活的接口设计，便于接口的变动。

⏹可扩展性原则：

支持新业务的扩展以及接口容量与接口性能的提高；

⏹可管理性原则：

提供良好的管理机制，保证在运行过程中提供给管理员方便的管理方式以处理各种情况；

⏹统一性原则：

应当保证系统的接口方式、接口形式、使用的协议等标准、统一。

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}?

数据类型

respCode

标识是否操作成功

0成功1失败

respDesc

当标识respCode为1时候显示错误信息

4.3.APP启动-初使化参数

初使化参数接口

前缀+/brands/param/list?

请求参数

无

shareFacebookUrl

fb分享的地址

shareFacebookKey

shareFacebookSecret

shareFacebookInfo

fb分享的内容

shareTwitterUrl

tw分享的地址

shareTwitterKey

shareTwitterSecret

shareTwitterInfo

tw分享的内容

shareEmail

shareEmailTitle

email分享的标题

maxNumOfFamilyMember

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

guidingTextOfHBC

HBC引导文字

helpTextOfHBC

HBC帮助文字

payType

支付类型

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

备注：

0成功

1失败

2用户其他手机登录

3用户登录后，被锁。

如果2或者3需要强行弹框，点击后直接退出到登录界面。

1视业务逻辑，选择是否强框