架构设计--用户端全http参数接口详细说明v1

1. 用户端全http参数接口详细说明v1.doc

2. change histor

p3t v1

作者:: 老哇的爪子 Attilax 艾龙， EMAIL:1466519819@qq.com

转载请注明来源： http://blog.csdn.net/attilax

3. 接口通用参数说明

接口地址 http://localhost:8080/shopitfs/api_http.jsp

接口测试工具：：浏览器直接测试。无需工具

调用范例（注册用户）

http://localhost:8080/shopitfs/api_http.jsp?method=regNormalUser&$user_name=aaaa&$user_passwd=hhh&datatype=mall_users&op=add

通用http参数说明（）

参数	说明	取值范例	参数值说明
op	操作动作	query,search,select,catch,poll 为查询操作 add/insert/create/reg为新增，注册操作	modify,update,edit为更新修改编辑数据操作 del,delete,remove为删除移除数据操作
datatype	数据类型	xxxxx	要操作的数据对象
$field (以美元符号开头的内部数据字段）	要新增或者更新的字段。只限于update、add操作使用	$user_name=aaaa
condition	条件	name='aaa' Name like like '%迪%'	支持>,<,=等操作符。支持and,or 逻辑操作符连接多个条件单引号作为字符串分界符模糊查询为 like '%%' 格式整个条件表达式语法与sql兼容。
@field (以猴头符号开头的条件表达式字段）	表明条件字段。。只能表达简单and条件。如需其他复杂查询，使用condition字段。当此参数与conditon参数都有的时候,conditon参数优先使用	@user_name=aaaa	多个字段直接只能and 条件。如需其他复杂查询，使用condition字段
order	排序字段	Id id desc a desc,b asc	数据的排序支持asc,desc排序。支持多字段排序，多字段用逗号分隔。语法与sql一致

page	翻页参数	1,10	1表示第一页，10表示pagesize

返回数据：：基本全部为json格式

多个数据对象的连接复合查询（规划中）：：

自定义函数的使用：：

默认参数全部支持mysql5数据库的默认函数。。。如果要使用自定义函数，可以通过函数注册接口注册自定义函数

注：为了方便使用，许多功能尽可能的兼容sql语法，方便查询文档资料

4. 函数注册接口（规划中）

方法名： regFunction

参数：：函数体

5. 用户权限模块

5.1. 用户注册接口（增加用户登陆数据）

调用方法 regNormalUser

数据类型： mall_users

详细字段数据结构

数据字段	类型	说明
`user_id`	int(10)	用户id'
`user_email`	varchar(100)	用户email'
`user_name`	varchar(50)	用户名'
`user_passwd`	varchar(50)	用户密码'
`user_question`	varchar(255)	密码找回问题'
`user_answer`	varchar(255)	密码找回答案'
`user_ico`	varchar(255)	'用户头像'
`reg_time`	datetime	注册时间'
`last_login_time`	datetime	最后登陆时间'
`last_ip`	char(15)	最后登陆ip'
`email_check`	tinyint(1)	邮件确认'
`email_check_code`	varchar(255)	邮件确认码'
`forgot_check_code`	varchar(255)	密码找回码'
`rank_id`	int(10)	用户级别'
`locked`	tinyint(1)	用户锁定，1为锁定'

调用范例

http://localhost:8080/shopitfs/api_http.jsp?method=regNormalUser&$user_name=aaaa&$user_passwd=hhh&datatype=mall_users&op=add

调用范例（参数sql格式：略）

调用范例（xx格式:略）

返回数据:: 一般返回空，如果有返回，数据结构同注册。。如有异常，返回异常信息

5.2. 登陆接口（查询用户登陆权限数据接口）

调用方法 login4NormalUser

数据类型：同注册接口

详细字段数据结构：：同注册接口

调用范例

http://localhost:8080/shopitfs/api_http.jsp?method=serachUserP3&@user_name=aaaa&@user_passwd=hhh&datatype=mall_users&op=query

返回数据::

如果有详细信息返回，登陆成功，数据结构同注册。。

如果无详细信息返回，说明密码错误

如有异常，返回异常。。

数据字段	类型	说明
`user_id`	int(10)	用户id'
`user_email`	varchar(100)	用户email'
`user_name`	varchar(50)	用户名'
`user_passwd`	varchar(50)	用户密码'
`user_question`	varchar(255)	密码找回问题'
`user_answer`	varchar(255)	密码找回答案'
`user_ico`	varchar(255)	'用户头像'
`reg_time`	datetime	注册时间'
`last_login_time`	datetime	最后登陆时间'
`last_ip`	char(15)	最后登陆ip'
`email_check`	tinyint(1)	邮件确认'
`email_check_code`	varchar(255)	邮件确认码'
`forgot_check_code`	varchar(255)	密码找回码'
`rank_id`	int(10)	用户级别'
`locked`	tinyint(1)	用户锁定，1为锁定'

6. 用户信息模块

6.1. 修改用户信息

调用方法 modifyUserinfo

数据类型： mall_user_info

详细字段数据结构：：

`id`	int(10)
`user_id`	int(10)	用户id'
`user_truename`	varchar(255)	真实姓名'
`user_ico`	varchar(255)	用户头像'
`user_marry`	tinyint(1)	0保密，1未婚，2已婚'
`user_gender`	tinyint(1)	0保密，1男，2女'
`user_mobile`	varchar(20)	用户手机号'
`user_telphone`	varchar(20)	用户电话'
`user_country`	smallint(6)	国家'
`user_province`	smallint(6)	省份'
`user_city`	smallint(6)	城市'
`user_district`	smallint(6)	区'
`user_zipcode`	char(6)	用户邮编'
`user_address`	varchar(255)	用户地址'
`user_birthday`	date	用户生日'
`user_qq`	varchar(16)	用户qq'
`user_msn`	varchar(50)	用户msn'
`user_skype`	varchar(50)	用户skype'

调用范例: 参考以上模块

返回数据:: 如有异常，返回异常。。

7. 商品模块

7.1. 调用范例

如上

7.2. 显示与查询商品列表接口

调用方法 searchGoods

操作数据类型：： mall_goods

数据字段	类型	说明
`goods_id`	int(10)	商品id
`shop_id`	int(10)	店铺id'
`goods_name`	varchar(255)	商品名称'
`cat_id`	int(10)	分类id'
`ucat_id`	int(10)	用户自定义分类id'
`brand_id`	int(10)	品牌id'
`type_id`	int(10)	属性类型id'
`goods_intro`	text	商品详情'
`goods_wholesale`	text	批发说明'
`goods_number`	int(5)	库存量'
`goods_price`	decimal(82)	商品价格'
`transport_price`	decimal(82)	运费'
`keyword`	varchar(255)	关键字'
`is_delete`	tinyint(1)	0为已删除'
`is_best`	tinyint(1)	1为精品'
`is_new`	tinyint(1)	1为新品'
`is_hot`	tinyint(1)	1为热销'
`is_promote`	tinyint(1)	1为特价'
`is_admin_promote`	tinyint(1)
`is_on_sale`	tinyint(1)	0为下架，1为上架'
`is_set_image`	tinyint(1)	是否已设置图片'
`goods_thumb`	varchar(255)	缩略图'
`pv`	int(10)	关注度'
`favpv`	int(10)	被收藏次数'
`sort_order`	tinyint(1)	排序'
`add_time`	datetime	添加时间'
`last_update_time`	datetime	最后修改时间'
`lock_flg`	tinyint(1)	锁定，1为锁定'
`is_transport_template`	tinyint(1)	是否启用邮费模版'
`transport_template_id`	int(11)	邮费模版id'
`transport_template_price`	float(50)	认默模板运费'

返回数据::

如果有数据，结构同上。。

如有异常，返回异常。。

7.3. 显示商品详情（显示一条商品数据）

调用方法 searchGoods

操作数据类型：： mall_goods

提交与返回的数据基本同搜索商品。。只需要设置条件类似 goods_id=1 就可。。。

8. 订单模块接口

8.1. 添加订单数据

调用方法 addOrderP29

数据类型： orderinfoVirt

范例

详细字段数据结构：：

`order_id`	int(10)	订单id'
`payid`	varchar(20)	支付订单号'
`shop_id`	int(10)	店铺id'
`pay_id`	int(10)	支付方式id'
`pay_name`	varchar(255)	支会方式名称'
`user_id`	int(10)	用户id'
`transport_price`	decimal(6	运费'
`order_value`	float	订单应付金额'
`order_amount`	decimal(10	总订单价格'
`consignee`	varchar(50)	联系人'
`country`	smallint(6)	0'	COMMENT	国家'
`province`	smallint(6)	省份'
`city`	smallint(6)	城市'
`district`	smallint(6)	地区'
`address`	varchar(255)	'	COMMENT	详细地址'
`zipcode`	char(6)	邮政编码'
`telphone`	varchar(20)	电话'
`mobile`	varchar(20)	手机'
`email`	varchar(255)	邮箱'
`shipping_name`	varchar(50)	物流公司名称'
`shipping_no`	varchar(50)	物流发货单号'
`shipping_type`	varchar(50)	发货运输类型'
`message`	text	COMMENT	订单附言'
`order_time`	datetime	订单时间'
`pay_time`	datetime	支付时间'
`shipping_time`	datetime	发货时间'
`receive_time`	datetime	用户已接收时间'
`order_status`	tinyint(1)	订单状态：0已取消订单，1用户已下订单，2商家已确认订单，3用户验货'
`pay_status`	tinyint(1)	支付状态：0未支付，1已支付'
`transport_status`	tinyint(1)	发货状态：0未发货，1已发货'
`protect_status`	tinyint(1)	0'	COMMENT	维权状态
`trade_no`	varchar(50)	支付宝返回的，支付宝交易号'
`seller_reply`	tinyint(1)	买家是否回复：0未回复，1回复'
`buyer_reply`	tinyint(1)	卖家是否回复：0未回复，1回复'
`group_id`	int(10)	团购id'
`pay_message`	text	COMMENT	支付留言'
`complaint`	tinyint(1)	用户投诉'
`get_back_time`	datetime	申请退款时间'
`transport_type`	int(11)	运输类型1Ems	2平邮，3快递'
`order_actual`	decimal(10	COMMENT	实付金额'

返回数据:: 无

如有异常，返回异常。。

8.2. 查询订单数据(多条与单条）

调用方法 queryOrderData

数据类型： order_goods_v

单条数据设置条件类似 order_id=1 就可

详细字段数据结构：：

同上。商品有关的信息同商品结构表