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

  1. 1、本文档共9页,可阅读全部内容。
  2. 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
  3. 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载
  4. 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多

服务端和手机平台

接口协议

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.91

V1.0

林成民

-8-06

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

V1.0

林成民

-8-12

修改4.49、4.50接口

V1.0

林成民

-12-14

修改4.3、4.68接口

目录

TOC\o1-4\h\z\u1. 概述 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

概述

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

包含接口

本文档包含外围系统接口包含:无

接口总体要求

系统间接口标准

接口设计遵照以下标准:

安全可靠性标准:系统应提供良好安全性和可靠性策略,支持多个安全而可靠技术手段,制订严格安全可靠管理方法;

开放性标准:提供开放式标准接口,提供和其它系统互联互通;

灵活性标准:提供灵活接口设计,便于接口变动。

可扩展性标准:支持新业务扩展和接口容量和接口性能提升;

可管理性标准:提供良好管理机制,确保在运行过程中提供给管理员方便管理方法以处理多种情况;

统一性标准:应该确保系统接口方法、接口形式、使用协议等标准、统一。

处理步骤

接口处理步骤

接口实现方法

手机APP应用和服务端采取基于HTTPREST协议完成,数据传输默认为JSON

请求消息

JSON(具体见下面各列表)

应答消息

json(JSON格式)

接口协议

http(rest协议)

接口实现者

Mascar_qis服务端

关键使用者

手机APP(androidiphone)

XXX服务端接口

测试地址前缀::8088/xxx/xxx

XX模块-依据XX下载相关配置文件

接口名称

下载相关配置文件

接口描述

依据厂商ID下载相关配置文件

测试地址

前缀+/file/download/{storeId}?token=

token参数详见配置

请求方法

GET

正式地址

待定

参数请求体

参数

参数含义

类型

长度

必填

说明

patform

平台

String

20

必填

值为iphone或android

响应体

XX模块-生成指定XX文件配置

接口名称

生成指定商家文件配置

接口描述

依据厂商ID,生成指定商家文件配置

测试地址

前缀+/file/generate/{storeId}?token=

token参数详见配置

请求方法

GET

正式地址

待定

参数请求体

响应体

参数

参数含义

数据类型

说明

respCode

标识是否操作成功

String

0成功1失败

respDesc

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

String

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分享内容

文档评论(0)

132****9517 + 关注
实名认证
内容提供者

该用户很懒,什么也没介绍

1亿VIP精品文档

相关文档