架構設計--用戶端全http參數接口具體說明v1
1. 用戶端全http參數接口具體說明v1.doc 1
2. change histor 1
3. 接口通用參數說明 1
4. 函數註冊接口(規劃中) 3
5. 用戶權限模塊 3
5.1. 用戶註冊接口(添加用戶登陸數據) 3
5.2. 登陸接口(查詢用戶登陸權限數據接口) 4
6. 用戶信息模塊 5
6.1. 改動用戶信息 5
7. 商品模塊 5
7.1. 調用範例 5
7.2. 顯示與查詢商品列表接口 6
7.3. 顯示商品詳情(顯示一條商品數據) 7
8. 訂單模塊接口 7
8.1. 加入訂單數據 7
8.2. 查詢訂單數據(多條與單條)
1. 用戶端全http參數接口具體說明v1.doc
2. change histor
p3t v1
作者:: 老哇的爪子 Attilax 艾龍。 EMAIL:[email protected]
轉載請註明來源: http://blog.csdn.net/attilax
3. 接口通用參數說明
接口地址 http://localhost:8080/shopitfs/api_http.jsp
接口測試工具:: 瀏覽器直接測試。無需工具
調用範例 (註冊用戶)
method=regNormalUser&$user_name=aaaa&$user_passwd=hhh&datatype=mall_users&op=add">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) |
username‘ |
|
`user_passwd` |
varchar(50) |
用戶password‘ |
|
`user_question` |
varchar(255) |
password找回問題‘ |
|
`user_answer` |
varchar(255) |
password找回答案‘ |
|
`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) |
password找回碼‘ |
|
`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
數據類型 : 同註冊接口
具體字段數據結構::同註冊接口
調用範例
method=serachUserP3&@user_name=aaaa&@user_passwd=hhh&datatype=mall_users&op=query">http://localhost:8080/shopitfs/api_http.jsp?
method=serachUserP3&@user_name=aaaa&@user_passwd=hhh&datatype=mall_users&op=query
返回數據::
假設有具體信息返回,登陸成功,數據結構同註冊。。
假設無具體信息返回,說明password錯誤
如有異常,返回異常。
。
數據字段 |
類型 |
說明 |
|
`user_id` |
int(10) |
用戶id‘ |
|
`user_email` |
varchar(100) |
用戶email‘ |
|
`user_name` |
varchar(50) |
username‘ |
|
`user_passwd` |
varchar(50) |
用戶password‘ |
|
`user_question` |
varchar(255) |
password找回問題‘ |
|
`user_answer` |
varchar(255) |
password找回答案‘ |
|
`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) |
password找回碼‘ |
|
`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) |
keyword‘ |
|
|
`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 就可
具體字段數據結構::
同上。商品有關的信息同商品結構表
架構設計--用戶端全http參數接口具體說明v1