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

服务端与手机通信接口规范 福建XXX科技有限公司 第 PAGE 9页/共 NUMPAGES 9页 服务端与手机平台 接口协议 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接口 目 录 TOC \o 1-4 \h \z \u HYPERLINK \l _Toc456691457 1. 概述 PAGEREF _Toc456691457 \h 4 HYPERLINK \l _Toc456691458 2. 涉及接口 PAGEREF _Toc456691458 \h 4 HYPERLINK \l _Toc456691459 3. 接口总体要求 PAGEREF _Toc456691459 \h 4 HYPERLINK \l _Toc456691460 3.1. 系统间接口的原则 PAGEREF _Toc456691460 \h 4 HYPERLINK \l _Toc456691461 3.2. 处理流程 PAGEREF _Toc456691461 \h 4 HYPERLINK \l _Toc456691462 3.3. 接口实现方式 PAGEREF _Toc456691462 \h 5 HYPERLINK \l _Toc456691463 4. XXX服务端接口 PAGEREF _Toc456691463 \h 5 HYPERLINK \l _Toc456691464 4.1. XX模块-根据XX下载相关的配置文件 PAGEREF _Toc456691464 \h 5 HYPERLINK \l _Toc456691465 4.2. XX模块-生成指定XX的文件配置 PAGEREF _Toc456691465 \h 6 HYPERLINK \l _Toc456691466 4.3. APP启动-初使化参数 PAGEREF _Toc456691466 \h 7 HYPERLINK \l _Toc456691467 5. 附件 PAGEREF _Toc456691467 \h 8 HYPERLINK \l _Toc456691468 5.1. 备注说明 PAGEREF _Toc456691468 \h 8 概述 本文档提供接口给手机端 使用，为手机端提供业务平台数据 涉及接口 本文档涉及的外围系统接口包括：无 接口总体要求 系统间接口的原则 接口设计遵循如下原则： 安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而可靠的技术手段，制定严格的安全可靠的管理措施； 开放性原则：提供开放式标准接口，提供与其它系统的互联互通； 灵活性原则：提供灵活的接口设计，便于接口的变动。 可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； 可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便的管理方式以处理各种情况； 统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统一。 处理流程 接口处理流程 接口实现方式 手机APP应用 与服务端采用基于HTTP的REST协议完成，数据传输默认为JSON 请求消息 JSON（详细见下面各列表) 应答消息 json (JSON格式) 接口协议 http（rest协议） 接口实现者 Mascar_qis 服务端 主要使用者 手机APP（androidiphone） XXX服务端接口 测试地址前缀: 08:8088/xxx/xxx XX模块-根据XX下载相关的配置文件 接口名称 下载相关的配置文件 接口描述 根据厂商ID下载相关的配置文件 测试地址 前缀+/HYPERLINK 08:8088/qis/mvc/rest/file/