点评微生活 - 商家API0909

API文档

目录

接口说明........................................................................................................................................... 2

每个接口对应一个唯一的url ................................................................................................. 2 调用方式 ................................................................................................................................... 2 参数格式 ................................................................................................................................... 2

POST 参数 ....................................................................................................................... 2 返回结果 ................................................................................................................................... 2

常见错误码 ....................................................................................................................... 2 正确返回示例 ................................................................................................................... 3 异常返回示例 ................................................................................................................... 3

方法示例........................................................................................................................................... 3

获取用户基本信息 ................................................................................................................... 3

/user/auth ........................................................................................................................... 3

附录1：sig 生成规则 ..................................................................................................................... 4 附录2：API调用流程 .................................................................................................................... 6 积分接口........................................................................................................................................... 8

积分兑换礼物 ........................................................................................................................... 8 交易接口........................................................................................................................................... 9

交易预览 ................................................................................................................................... 9 交易提交 ................................................................................................................................. 11 交易冲正 ................................................................................................................................. 12 交易撤销 ................................................................................................................................. 13 设置接口......................................................................................................................................... 13

获取收银员列表 ..................................................................................................................... 13 用户接口......................................................................................................................................... 14

验证登录 ................................................................................................................................. 14 获取用户账户信息 ................................................................................................................. 15 优惠券接口..................................................................................................................................... 16

发券......................................................................................................................................... 16 活动列表 ................................................................................................................................. 17

接口说明

每个接口对应一个唯一的url

https://wlapi.dianping.com/user/list

调用方式

以 Restful Service 的方式提供接口调用。

参数格式

通过 post方式传递数据。

POST 参数

说明 各个请求方法对应的参数 发起请求的时间戳 结果返回的数据格式，暂时只支持 JSON 客户端名称，字符串 通过参数和密钥生成的加密字符串。生成规则见附录 调用接口的版本 变量名 req ts fmt appid sig v 返回结果

接口返回数据为一个数组，包含三个键值： 说明 错误码。0 表示正常返回，否则表示有异常 错误说明。异常说明信息 请求方法执行结果 键值 errcode errmsg res 常见错误码

代码 说明 1001 1002 1003 1004 3001 3002 3003

参数错误 数据的签名验证异常 未知的系统异常 该接口目前无法调用 未知的 cno 指定的会员不存在 未知的 cashier_id 正确返回示例

{\}

异常返回示例

{\

方法示例

获取用户基本信息 /user/auth

方法说明

验证登录台，并获取用户的基本信息

Post参数

键名 wl_token

数据类型 string 说明 前端页面获取到的 返回结果

索引数组，商品列表信息，每个元素具体返回字段如下表所示 键名 cno phone name sex grade balance credit 数据类型 int int string int int int int 说明 卡号 手机号 名字 性别 1 男 2 女 0 未知 等级 储值余额 积分 附录1：sig 生成规则

前提

从商家后台获取客户端和服务端通信加密使用的appkey，一个appid对应一个appkey。

生成规则

1. 将参数数组按照key升序(递归，子数组也要排序) 2. 排序后的数组生成查询字符串(键值对需要urlencode) 3. 依次连接appid，appkey，版本号，时间戳 4. md5

示例：

参数数组如下： array( grade => 1, offset => 0, limit => 20, orderby => array( balance => desc

) )

排序以后得到结果 array( grade => 1, limit => 20, offset => 0, orderby => array(

balance => desc

)

)

构造查询字符串以后得到：

grade=1&limit=20&offset=0&orderby[balance]=desc

依次连接appid，appkey，版本号，时间

grade=1&limit=20&offset=0&orderby[balance]=desc&appid=ct_ZjQ4NmU2OTE0OGY1MTJ&appkey= 202cb962ac59075b964b07152d234b70&v=1.0&ts=1426773603

md5以后得到sig

51bdc1dd175c5f2d973e392bfa412ef7

因此本次POST请求需要传的参数为：

req={\”orderby”:{“balance”:”desc”}}&appid= ct_ZjQ4NmU2OTE0OGY1MTJ&v=1.0&ts=1426840526&sig= 51bdc1dd175c5f2d973e392bfa412ef7&fmt=JSON

附录2：shop_id 获取方式

在点评网站上面，打开商家自己的门店页面 例如：http://www.dianping.com/shop/22973436 URL地址最后的数字就是此门店的shop_id

附录3：API调用流程

积分接口

积分兑换礼物

https://wlapi.dianping.com/credit/exchange

方法说明

仅限于积分兑换礼物，记录会在兑换记录处显示

Post参数

键名 uid cashier_id sub_credit desc biz_id

数据类型 int int int string string 说明 微生活用户UID 收银员ID 扣减的积分数 兑换的礼物详情 业务号 长度 - - 5 50 30 是否必填 是 是 是 是 是 返回结果

键名 uid biz_id

数据类型 int string 说明 微生活用户UID 业务号 交易接口

交易预览

https://wlapi.dianping.com/deal/preview

方法说明

交易预览，预览时交易并未真正生效，只是查看交易可能产生的后果

Post参数

键名 uid 数据类型 bigint 说明 微生活用户UID 长度 - 是否必须 是 cno shop_id cashier_id consume_amount sub_balance deno_coupon_ids gift_coupons_ids sub_gift sub_credit activity_ids payment_amount payment_mode count_num biz_id

int int int int int json json int int json int int int string 卡号 门店ID 收银员ID 消费金额（单位：分） 使用储值金额（单位：分） 使用代金券数组，示例： [\使用礼品券数组，示例： [\使用礼品券后折扣的金额（单位：分） 使用积分抵现，积分数量 参加活动数组，示例： [\，空[] 支付金额（单位：分） 支付方式 1 现金 2 刷卡 本次交易应累计的次数 业务号，收银方自行保证唯一 - - - 5 5 - - - - - 5 - - 30 是 是 是 是 否 否 否 否 否 是 是 是 是 是 返回结果

键名 verify_sms grade balance credit coupons 数据类型 boolean int int int json 说明 是否需要提交短信验证码进行确认（通常在使用了储值时）。 升级至的等级名称（如果本次交易成功后满足升级标准的话，否则为null） 交易后的储值余额（如果本次交易使用了储值的话，否则为null）。（单位：分） 交易后的积分余额（如果本次交易使用了积分的话，否则为null）。 送券的数组，且各券信息包括如下各字段，见下表。 JSON示例： [{\元代金券\仅限午餐使用一次仅可使用一张\飞天神马QQ公仔\仅限午餐使用一次仅可使用一张\如有新字段添加，将不再特意通知。

coupons 数组，本接口最多返回50张可用的券 键名 couponId type name amount summary num

数据类型 int int int int string int 说明 模板ID 券类型（1：代金券，2：礼品券） 券标题 券面额（如果是代金券的话，否则为0）（单位：分） 使用条件与限制，被 ul 和 li 标签，见示例。 此券将赠送多少张 如有新字段添加，将不再特意通知。 交易提交

https://wlapi.dianping.com/deal/commit

方法说明

交易提交，预览过的交易只有在提交以后才会真实生效

Post参数

键名 biz_id verify_sms

数据类型 string string 说明 业务号 长度 - 是否必填 是 短信验证码（如果使用了储值的话） 返回结果

键名 deal_id

数据类型 string 说明 交易ID 交易冲正

https://wlapi.dianping.com/deal/rollback

方法说明

交易冲正，不管之前commit的交易是否生效，都取消掉，冲正记录不会在交易记录显示，仅限于调用commit接口无返回或者接口出错，未知交易是否成功，强制取消掉交易

Post参数

键名 biz_id

数据类型 string 说明 业务号 长度 - 是否必填 是 返回结果

键名 result

数据类型 string 说明 成功返回“OK”。 交易撤销

https://wlapi.dianping.com/deal/cancel

方法说明

交易撤销，交易成功以后，使用交易ID撤销本笔交易

Post参数

键名 biz_id cashier_id

数据类型 string int 说明 业务号 收银员ID 长度 - - 是否必填 是 是 返回结果

键名 result

数据类型 string 说明 成功返回“OK”。 设置接口

获取收银员列表

https://wlapi.dianping.com/cashier/list

方法说明

获取收银员列表

Post参数

键名 shop_id page 数据类型 int int 说明 门店ID 分页，默认为 1 ，每页100收银员 长度 - - 是否必填 是 否

返回结果

数组 键名 cashier_id shop_id username nickname 数据类型 int int string string 说明 收银员ID 所属门店 登录名 昵称 用户接口

验证登录

https://wlapi.dianping.com/user/auth

方法说明

验证登录态，并获取用户的基本信息

Post参数

键名 wl_token

数据类型 string 说明 前端页面获取到的 长度 - 是否必填 是 返回结果

键名 cno openid name sex birthday grade 数据类型 int int string int string int 说明 卡号 微信OpenId 名字 性别 1 男 2 女 0 未知 出生年月日 yyyy-mm-dd 等级 balance credit

int int 储值余额 积分 获取用户账户信息

https://wlapi.dianping.com/user/account

方法说明

获取用户的账户信息

Post参数

键名 cno

数据类型 int 说明 用户的卡号或手机号 长度 - 是否必填 是 返回结果

键名 uid type openid grade balance 数据类型 int string string int int 说明 用户编号UID wx/dp 微信openid 等级 储值余额（单位：分）

credit coupons int array 积分 可用的券

coupons 数组，本接口最多返回50张可用的券 键名 template_id coupon_ids title deno type shop_ids effective_time failure_time limitations

数据类型 int array int int int array string string string 说明 模板ID，相同的券模板ID一样 券实际的ID数组 券标题 券面额（单位：分） 类型，代金券还是礼品券 适用门店ID数组 生效时间 失效时间 使用条件与限制 优惠券接口

发券

https://wlapi.dianping.com/coupon/send

方法说明

手动发券，需要单独申请

Post参数

键名 uid template_id amount biz_id

数据类型 bigint int int string 说明 微生活用户UID 券张数 业务号 长度 - 小于 50 30 是否必填 是 是 是 是 券模板ID（线下获取） - 返回结果

键名 数据类型 说明 biz_id

string 业务号 活动列表

https://wlapi.dianping.com/activity /list

方法说明

获取用户可参加的活动列表

Post参数

键名 uid shop_id

数据类型 bigint int 说明 微生活用户UID 门店ID 是否必填 是 是 返回结果

键名 aid type name amount livetime 数据类型 int int string int array 说明 活动ID 活动类型（1：消费满赠，2：累计金额满赠，4：累计次数满赠） 活动名称（最长 12 个字符，包括中文） 消费满（或累计满）金额（或次数），金额单位为分。 活动的有效时间段，为一个数组（列表），无时间段限制时，为空数组。JSON示例： [\ 成功参加该活动后，可获得的代金券或礼品券列表。 JSON示例： coupons array [{\元代金券\ame\飞天神马QQ公仔\ 字段说明： couponId：券唯一ID。 name：券名称。 amount：如果是代金券，此字段为金额（分）。 num：赠送的张数，比如示例中50元代金券送2张。 type：券类型（1：代金券，2：礼品券）。 如有新字段添加，将不再特意通知。

本文来源：https://www.bwwdw.com/article/jgi8.html