安卓与web服务端数据交互的接口定义文档

Table of Contents 目录

1简介 (3)

2终端与系统平台接口简略图 (3)

2.1终端与系统平台接口描述图 (3)

3WEBServer与DBDao接口（API-2接口） (3)

4PAD与WEB Server平台接口（API-1接口） (3)

4.1API-1接口描述 (3)

4.2用户登录 (4)

4.3首页------获得推荐的模块图片 (5)

4.4物业---公告板---分页获得(大家/个人)公告 (5)

4.5物业---公告板---获得一个公告 (6)

4.6物业---公告板---发布公告 (6)

4.7物业---公告板---编辑公告 (7)

4.8物业---通知—分页获得新通知 (7)

4.9物业---通知—获得一条通知 (8)

4.10物业---账单—获得某年某月的账单 (8)

4.11商城---商品中心--获得商品类别(大类别/子类别) (9)

4.12商城---商品中心--获得商品列表 (10)

4.13商城---商品中心--获得多个/单个推荐商品 (11)

4.14商城---商品中心--获得单个商品详细 (12)

4.15商城---商品中心--添加订单 (13)

4.16商城---我的账户—获得最近的一条账单和账单详情 (13)

4.17商城---我的账户—获得消费信息 (14)

4.18商城---我的账户- -生成商品类型的报表 (14)

4.19商城---我的账户- -生成年度每个月消费情况的报表 (15)

1 简介

本文档旨在对终端与系统平台接口技术规范进行说明，用于指导开发人员进行相关业务的开发。

2 终端与系统平台接口简略图

2.1 终端与系统平台接口描述图

PAD（Terminal）与系统平台有以下接口：

●与Web平台的接口（API-1）

WEB（Server）与系统平台有以下接口：

●与DBDao的接口（API-2）

3 WEBServer与DBDao接口（API-2接口）

通过DBDao接口对DB进行操作

4 PAD与WEB Server平台接口（API-1接口）

4.1 API-1接口描述

PAD与WEB Server平台之间具有以下接口模块：

（1）.用户登录接口

（2）.首页信息实时更新接口

（3）.物业-公告板接口

（4）.物业-通知接口

（5）.物业-管家接口

（6）.物业-账单接口

（7）.用户登出接口

（8）.商城-主页接口

（9）.商城-推荐商品接口

（10）.商城-添加订单接口

（11）.商城-支付接口

（12）.娱乐-推荐电影海报接口

. . . . . .

WEB Server返回的异常信息的格式

系统返回的异常信息由2部分组成

a)HTTP协议头的http Status Code,统一返回错误码，其定义继承http/1.1协议，业

务错误码区间范围[416,499]。Status Code和Error Code的定义参照《Applogic错误码

定义.docx》。

HTTP/1.1 xxx Internal Server Error

Server: Apache-Coyote/1.1

Content-Type: text/xml;charset=utf-8

Content-Length: 2770

Date: Thu, 31 Mar 2011 03:56:51 GMT

Connection: close

b)HTTP Response里返回的错误报文，报文格式如下

{errorResponse:[{"code":466,"message":"NullException","detail":"..."}

]}

Web or PAD 端进入系统时需要用户名和密码进行验证。

功能和

说明

Request Direction Terminal ---->WEB Server

传输协议http Get

格式https://{WEB SERVER_IP} /user_PADLogin.do?{PARAM}

参数userName=xxxxx：用户名

password=xxxx：用户密码

例子https://web_server_ip/user_PADLogin.do?userName=test&password

=123456

4.8 物业---通知—分页获得新通知

4.13 商城—商品中心—获得所有生活方式

4.15 商城---商品中心--获得多个/单个推荐商品

4.16 商城---商品中心--获得单个商品详细

4.17 商城---商品中心--添加订单

4.18 商城---我的账户—获得最近的一条账单和账单详情

4.19 商城---我的账户—获得消费信息

4.20 商城---我的账户- -生成商品类型的报表

4.21 商城---我的账户- -生成年度每个月消费情况的报表