| 版本 |
作者 |
日期 |
描述 |
| v1.0.0 |
張中建 |
2017-12-06 |
為方便前端、移動端與后臺的聯調，特制定本規范；如有變更請及時通知 |
| v1.0.0 |
張中建 |
2017-12-07 |
完成天天紅包用戶分享，查看領獎記錄、開獎接口 |
| v1.0.1 |
張中建 |
2017-12-13 |
避免關鍵字將分享信息下的abstract改為detail |
| v1.0.2 |
張中建 |
2017-12-15 |
查詢開獎記錄增加openId |
統一說明
- 目前需要約定有的wap和app，特定義device來加以區別當前請求，合理的值為wap或app
- 所有的響應都有以下2個key
{
code: 9999, //所有請求都會有該key存在 9999代表成功
msg: "success" //非正常請求時需要將該消息彈出提示用戶
}
1.用戶分享
接口地址
/${device}/user/share
業務參數說明
| 名稱 |
類型 |
是否必須 |
參數說明 |
| uId |
int |
Y |
登錄成功后端用戶返回的用戶標識 大于0 小于999999 否則報非法請求 eg:9527 |
返回結果
{
uId:9527,
sign:"4b38d99d2b63e54873143342b121d9c4,
share:"y",
shareInfo:{
title:"加金調料包，每天領一包，收益節節高！給你的錢包充能！",
detail:"快和你的小伙伴一起來瓜分百萬紅包吧！",
img:"http://www.jfcaifu.com",
url:"http://www.jfcaifu.com/activity/redpacket.html",
forward:{
friends :"y",
moments :"n",
sina:"y"
}
}
}
返回字段說明
| 名稱 |
類型 |
字段說明 |
| uId |
int |
請求分享接口的用戶標識 |
| addr |
String |
分享出去的鏈接地址 |
| sign |
String |
對分享地址MD5的唯一標識，開獎時需要將該值回傳驗證
|
| share |
char |
該值為y，表示需要分享 |
| shareInfo |
String |
對share的詳細說明 |
| title |
String |
分享標題 |
| detail |
String |
對某一功能的摘要說明 |
| img |
String |
分享圖片對應地址 |
| url |
String |
分享出去的鏈接 |
| forward |
String |
轉發平臺 friends 朋友圈 moments 朋友圈 sina 新浪 為y前端需要顯示相應的平臺 |
2.獲獎記錄
接口地址
/${device}/user/records
請求方式
POST
業務參數說明
| 名稱 |
類型 |
是否必須 |
參數說明 |
| uId |
int |
N |
用戶標識 eg:9527 |
| tele |
String |
N |
本次要查詢領取記錄的手機號 與 sign 二選一 |
| page |
int |
N |
查看領取記錄當前頁碼 默認為：1
|
| sign |
String |
N |
當查看某個紅包的領取記錄時需要傳該值 與 tele 二選一 |
| openId |
String |
Y |
用戶在點擊紅包鏈接時后臺返回給前端的一個用戶標識 |
返回結果
{
uId: 9527,
total:11,
records:[ {
id: 9527,
serial:"51ec6f59dbcb2084fcb47f8e2a04c5e3",
avatar:"http://wx.qlogo.cn/mmopen/JcDicrZBlREhnNXZRudod9Pmib",
nickname:"咩咩羊",
amount: 100.00,
amtTxt:"100.00元現金券",
category: 2,
cateText: "現金券",
status: 1,
remark: "投資15天及以上產品滿5000元可用",
startDate: "2017-08-05",
endDate: "2017-12-03",
createdDate:"2017-10-08 11:11:11"
}]
……
}
返回字段說明
| 名稱 |
類型 |
字段說明 |
| uId |
int |
用戶標識 eg:9527 |
| tele |
String |
聯系方式 |
| total |
int |
后臺計算出用戶的領取紅包的總頁數 前端需要根據該值判斷允許滑動的最大次數 |
| records |
List |
用戶領取的獎勵集，前端需要考慮為空的情況 ，避免閃退 |
| id |
int |
領取獎勵的唯一標識，當點擊使用時需要將該值傳回后端
|
| serial |
String |
領取紅包的序列號 |
| avatar |
String |
微信返回的用戶頭像地址 |
| nickname |
String |
微信返回的用戶昵稱 |
| amount |
BigDecimal |
當前領取的獎勵面值 eg:現金100.00 紅包 78.00 加息券：3.7 |
| amtTxt |
String |
后端組裝完整的面值說明，需要就取不需要忽略 |
| category |
int |
1 現金 2紅包券 3全程加息券 |
| cateText |
String |
對category的中文解釋 前端直接取該值即可 |
| status |
int |
所領取獎勵當前的一個狀態 0初始化 1未使用(已同步) 2已使用 3已過期（失效） |
| remark |
String |
獎勵的使用范圍說明 |
| startDate |
String |
獎勵的生效日期 eg：2017-12-12 |
| endDate |
String |
獎勵的失效日期 eg：2017-12-19 |
| createdDate |
String |
獎勵獲得時間 eg：2017-12-12 12:12:12 |
3.領取紅包
接口地址
/${device}/open/red_packet
請求方式
POST
業務參數說明
| 名稱 |
類型 |
是否必須 |
參數說明 |
| tele |
String |
Y |
用戶填寫有效的11位聯系方式，前后端都要正則驗證合法性 |
| sign |
int |
Y |
用戶訪問分享鏈攜帶的標識 |
| uId |
int |
N |
用戶標識 eg:9527 |
返回結果
{
uId:9527,
tele:"138767676767"
msg: "紅包已領取 | 活動已結束 | 每人每天只能領取一個紅包喲貪心會長胖噠~"
records:"[{
id: 1314,
avatar:"http://wx.qlogo.cn/mmopen/JcDicrZBlREhnNXZRudod9Pmib",
nickname:"咩咩羊",
amount: 100.00,
amtTxt:"100.00元現金券",
category: 2,
cateText: "現金券",
status: 1,
remark: "投資15天及以上產品滿5000元可用",
startDate: "2017-12-12",
endDate: "2017-12-19",
createdDate:"2017-12-12 12:13:14"
}]"
……
}
返回字段說明
| 名稱 |
類型 |
字段說明 |
| uId |
int |
用戶標識 只有后臺能識別出用戶且在金蜂系統存在的情況下才有 eg：9527 |
| tele |
String |
當前領取人填寫的手機號 |
| msg |
String |
后端根據領取邏輯返回的一個提示信息 直接彈出給用戶展示即可 |
| records |
List |
當前紅包的領取情況 參考領取記錄records解釋 |
唯有完美的團隊才能造就我完美的個人，團結就是力量
