點(diǎn)評(píng)微生活_商家API0909

1、API文檔目錄接口說(shuō)明2每個(gè)接口對(duì)應(yīng)一個(gè)唯一的url2調(diào)用方式2參數(shù)格式2POST 參數(shù)2返回結(jié)果2常見(jiàn)錯(cuò)誤碼3正確返回示例3異常返回示例3方法示例3獲取用戶基本信息3/user/auth3附錄1：sig 生成規(guī)則4附錄2：API調(diào)用流程6積分接口8積分兌換禮物8交易接口9交易預(yù)覽9交易提交11交易沖正12交易撤銷13設(shè)置接口13獲取收銀員列表13用戶接口14驗(yàn)證登錄14獲取用戶賬戶信息15優(yōu)惠券接口16發(fā)券16活動(dòng)列表17接口說(shuō)明每個(gè)接口對(duì)應(yīng)一個(gè)唯一的url調(diào)用方式以 Restful Service 的方式提供接口調(diào)用。參數(shù)格式通過(guò) post方式傳遞數(shù)據(jù)。POST 參數(shù)變量名說(shuō)明req各個(gè)請(qǐng)

2、求方法對(duì)應(yīng)的參數(shù)ts發(fā)起請(qǐng)求的時(shí)間戳fmt結(jié)果返回的數(shù)據(jù)格式，暫時(shí)只支持 JSONappid客戶端名稱，字符串sig通過(guò)參數(shù)和密鑰生成的加密字符串。生成規(guī)則見(jiàn)附錄v調(diào)用接口的版本返回結(jié)果接口返回?cái)?shù)據(jù)為一個(gè)數(shù)組，包含三個(gè)鍵值：鍵值說(shuō)明errcode錯(cuò)誤碼。0 表示正常返回，否則表示有異常errmsg錯(cuò)誤說(shuō)明。異常說(shuō)明信息res請(qǐng)求方法執(zhí)行結(jié)果常見(jiàn)錯(cuò)誤碼代碼說(shuō)明1001參數(shù)錯(cuò)誤1002數(shù)據(jù)的簽名驗(yàn)證異常1003未知的系統(tǒng)異常1004該接口目前無(wú)法調(diào)用3001未知的 cno3002指定的會(huì)員不存在3003未知的 cashier_id正確返回示例"errcode":0,"

3、errmsg":"OK","res":"wlid":"12201135853160167267","type":"dianping","sex":"1"異常返回示例"errcode":10003,"errmsg":" sig verification error ","res":null方法示例獲取用戶基本信息 /user/auth方法說(shuō)明驗(yàn)證登錄

4、臺(tái)，并獲取用戶的基本信息Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明wl_tokenstring前端頁(yè)面獲取到的返回結(jié)果索引數(shù)組，商品列表信息，每個(gè)元素具體返回字段如下表所示鍵名數(shù)據(jù)類型說(shuō)明cnoint卡號(hào)phoneint手機(jī)號(hào)namestring名字sexint性別 1 男 2 女 0 未知gradeint等級(jí)balanceint儲(chǔ)值余額creditint積分附錄1：sig 生成規(guī)則前提從商家后臺(tái)獲取客戶端和服務(wù)端通信加密使用的appkey，一個(gè)appid對(duì)應(yīng)一個(gè)appkey。生成規(guī)則1. 將參數(shù)數(shù)組按照key升序(遞歸，子數(shù)組也要排序)2. 排序后的數(shù)組生成查詢字符串(鍵值對(duì)需要urlencode)3.

5、依次連接appid，appkey，版本號(hào)，時(shí)間戳4. md5示例：參數(shù)數(shù)組如下：array(grade => 1,offset => 0,limit => 20,orderby => array(balance => desc)排序以后得到結(jié)果array(grade => 1,limit => 20,offset => 0,orderby => array(balance => desc)構(gòu)造查詢字符串以后得到：grade=1&limit=20&offset=0&orderby%5Bbalance%5D=des

6、c依次連接appid，appkey，版本號(hào)，時(shí)間 grade=1&limit=20&offset=0&orderby%5Bbalance%5D=desc&appid=ct_ZjQ4NmU2OTE0OGY1MTJ&appkey= 202cb962ac59075b964b07152d234b70&v=1.0&ts=1426773603md5以后得到sig51bdc1dd175c5f2d973e392bfa412ef7因此本次POST請(qǐng)求需要傳的參數(shù)為：req="grade":1,"limit":20,&

7、quot;offset":0,”orderby”:“balance”:”desc”&appid= ct_ZjQ4NmU2OTE0OGY1MTJ&v=1.0&ts=1426840526&sig= 51bdc1dd175c5f2d973e392bfa412ef7&fmt=JSON附錄2：shop_id 獲取方式在點(diǎn)評(píng)網(wǎng)站上面，打開(kāi)商家自己的門店頁(yè)面例如：URL地址最后的數(shù)字就是此門店的shop_id附錄3：API調(diào)用流程積分接口積分兌換禮物方法說(shuō)明僅限于積分兌換禮物，記錄會(huì)在兌換記錄處顯示Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填uidint微生活用

8、戶UID-是cashier_idint收銀員ID-是sub_creditint扣減的積分?jǐn)?shù)5是descstring兌換的禮物詳情50是biz_idstring業(yè)務(wù)號(hào)30是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明uidint微生活用戶UIDbiz_idstring業(yè)務(wù)號(hào)交易接口交易預(yù)覽方法說(shuō)明交易預(yù)覽，預(yù)覽時(shí)交易并未真正生效，只是查看交易可能產(chǎn)生的后果Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必須uidbigint微生活用戶UID-是cnoint卡號(hào)-是shop_idint門店ID-是cashier_idint收銀員ID-是consume_amountint消費(fèi)金額（單位：分）5是sub_balanceint使用儲(chǔ)值

9、金額（單位：分）5否deno_coupon_idsjson使用代金券數(shù)組，示例："1496517402155926","1496517402155927"-否gift_coupons_idsjson使用禮品券數(shù)組，示例："1496517402155926","1496517402155927"-否sub_giftint使用禮品券后折扣的金額（單位：分）-否sub_creditint使用積分抵現(xiàn)，積分?jǐn)?shù)量-否activity_idsjson參加活動(dòng)數(shù)組，示例："3001","3005&q

10、uot;，空-是payment_amountint支付金額（單位：分）5是payment_modeint支付方式 1 現(xiàn)金 2 刷卡-是count_numint本次交易應(yīng)累計(jì)的次數(shù)-是biz_idstring業(yè)務(wù)號(hào)，收銀方自行保證唯一30是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明verify_smsboolean是否需要提交短信驗(yàn)證碼進(jìn)行確認(rèn)（通常在使用了儲(chǔ)值時(shí)）。gradeint升級(jí)至的等級(jí)名稱（如果本次交易成功后滿足升級(jí)標(biāo)準(zhǔn)的話，否則為null）balanceint交易后的儲(chǔ)值余額（如果本次交易使用了儲(chǔ)值的話，否則為null）。（單位：分）creditint交易后的積分余額（如果本次交易使用了積分的話，否

11、則為null）。couponsjson送券的數(shù)組，且各券信息包括如下各字段，見(jiàn)下表。JSON示例："couponId":"1001","name":"50元代金券","amount":5000,"num":2,"type":1,"summary":"<ul><li>僅限午餐使用<li><li>一次僅可使用一張<li></ul>"",&q

12、uot;couponId":"1002","name":"飛天神馬QQ公仔","amount":0,"num":1,"type":2,"summary":"<ul><li>僅限午餐使用<li><li>一次僅可使用一張<li></ul>"如有新字段添加，將不再特意通知。coupons 數(shù)組，本接口最多返回50張可用的券鍵名數(shù)據(jù)類型說(shuō)明couponIdint模

13、板IDtypeint券類型（1：代金券，2：禮品券）nameint券標(biāo)題amountint券面額（如果是代金券的話，否則為0）（單位：分）summarystring使用條件與限制，被 ul 和 li 標(biāo)簽，見(jiàn)示例。numint此券將贈(zèng)送多少?gòu)埲缬行伦侄翁砑?，將不再特意通知。交易提交方法說(shuō)明交易提交，預(yù)覽過(guò)的交易只有在提交以后才會(huì)真實(shí)生效Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填biz_idstring業(yè)務(wù)號(hào)-是verify_smsstring短信驗(yàn)證碼（如果使用了儲(chǔ)值的話）返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明deal_idstring交易ID交易沖正方法說(shuō)明交易沖正，不管之前commit的交易是否生效，都取

14、消掉，沖正記錄不會(huì)在交易記錄顯示，僅限于調(diào)用commit接口無(wú)返回或者接口出錯(cuò)，未知交易是否成功，強(qiáng)制取消掉交易Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填biz_idstring業(yè)務(wù)號(hào)-是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明resultstring成功返回“OK”。交易撤銷方法說(shuō)明交易撤銷，交易成功以后，使用交易ID撤銷本筆交易Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填biz_idstring業(yè)務(wù)號(hào)-是cashier_idint收銀員ID-是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明resultstring成功返回“OK”。設(shè)置接口獲取收銀員列表方法說(shuō)明獲取收銀員列表Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填shop_idint

15、門店ID -是pageint分頁(yè)，默認(rèn)為 1 ，每頁(yè)100收銀員-否返回結(jié)果數(shù)組鍵名數(shù)據(jù)類型說(shuō)明cashier_idint收銀員ID shop_idint所屬門店usernamestring登錄名nicknamestring昵稱用戶接口驗(yàn)證登錄方法說(shuō)明驗(yàn)證登錄態(tài)，并獲取用戶的基本信息Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填wl_tokenstring前端頁(yè)面獲取到的-是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明cnoint卡號(hào)openidint微信OpenIdnamestring名字sexint性別 1 男 2 女 0 未知birthdaystring出生年月日 yyyy-mm-ddgradeint等級(jí)bala

16、nceint儲(chǔ)值余額creditint積分獲取用戶賬戶信息方法說(shuō)明獲取用戶的賬戶信息Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填cnoint用戶的卡號(hào)或手機(jī)號(hào)-是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明uidint用戶編號(hào)UIDtypestringwx/dpopenidstring微信openidgradeint等級(jí)balanceint儲(chǔ)值余額（單位：分）creditint積分couponsarray可用的券coupons 數(shù)組，本接口最多返回50張可用的券鍵名數(shù)據(jù)類型說(shuō)明template_idint模板ID，相同的券模板ID一樣coupon_idsarray券實(shí)際的ID數(shù)組titleint券標(biāo)題denoint券

17、面額（單位：分）typeint類型，代金券還是禮品券shop_idsarray適用門店ID數(shù)組effective_timestring生效時(shí)間failure_timestring失效時(shí)間limitationsstring使用條件與限制優(yōu)惠券接口發(fā)券方法說(shuō)明手動(dòng)發(fā)券，需要單獨(dú)申請(qǐng)Post參數(shù)鍵名數(shù)據(jù)類型說(shuō)明長(zhǎng)度是否必填uidbigint微生活用戶UID-是template_idint券模板ID（線下獲?。?是amountint券張數(shù) 小于 50是biz_idstring業(yè)務(wù)號(hào)30是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明biz_idstring業(yè)務(wù)號(hào)活動(dòng)列表 /list方法說(shuō)明獲取用戶可參加的活動(dòng)列表Post參

18、數(shù)鍵名數(shù)據(jù)類型說(shuō)明是否必填uidbigint微生活用戶UID是shop_idint門店ID是返回結(jié)果鍵名數(shù)據(jù)類型說(shuō)明aidint活動(dòng)ID typeint活動(dòng)類型（1：消費(fèi)滿贈(zèng)，2：累計(jì)金額滿贈(zèng)，4：累計(jì)次數(shù)滿贈(zèng)）namestring活動(dòng)名稱（最長(zhǎng) 12 個(gè)字符，包括中文）amountint消費(fèi)滿（或累計(jì)滿）金額（或次數(shù)），金額單位為分。livetimearray活動(dòng)的有效時(shí)間段，為一個(gè)數(shù)組（列表），無(wú)時(shí)間段限制時(shí)，為空數(shù)組。JSON示例："5:00-9:00", "11:00-14:00", "17:00-19:00"couponsarray成功參加該活動(dòng)后，可獲得的代金券或禮品券列表。JSON示例："couponId":"1001","name":"50元代金券","amount":5