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