接入指南

接口域名

测试环境 https://test-rights-platform.e-buy.com
生产环境 https://rights-platform.e-buy.com

接口调用方式

提交方式 HTTP POST方式提交,CONTENT-TYPE为application/json
报文格式 json
字符编码 utf-8
签名算法 sha256

安全规范

除sign参数外的所有参数按照ASCII顺序排序后,以"参数名1=参数值1&参数名2=参数值2"的方式拼接所有参数

对所有业务参数的json格式做base64再行拼接

最后在尾部拼接双方约定的密钥"appSecret=xxxxx",

sha256加密后即为签名值,并赋给sign参数。

当参数值为null或为空时不参与签名串拼接

JSONObject notifyJson = new JSONObject(true);
notifyJson.put("orderNo", "4200001172202109274275163730");
notifyJson.put("transDateTime", "20210928102350");
notifyJson.put("ebuyCode", "1002108300000059091");
notifyJson.put("faceValue", "30");
notifyJson.put("outTradeNo", "89392109280163981");

byte[] encodeBase64 = Base64.encodeBase64(notifyJson.toJSONString().getBytes("UTF-8"));
String bizContent = new String(encodeBase64, "UTF-8");

Map<String, String> map = new TreeMap<>();
map.put("appKey", "274b9cf9f01543619baa726ed24ddd19");
map.put("signType", "sha256");
map.put("timestamp", "1483372334");
map.put("bizContent", bizContent);

StringBuilder buffer = new StringBuilder();
for (Map.Entry<String, String> item : map.entrySet()) {
buffer.append(item.getKey()).append("=").append(item.getValue()).append("&");
}

String signStr = buffer.toString() + "appSecret=XXXXXXXXXXXX";// appSecret(需易百提供);
String checkSign = SHAUtil.sha256(signStr);
System.out.println(signStr);
System.out.println(checkSign);

拼接后签名串:action=verify&appKey=274b9cf9f01543619baa726ed24ddd19&bizContent=eyJvcmRlck5vIjoiNDIwMDAwMTE3MjIwMjEwOTI3NDI3NTE2MzczMCIsInRyYW5zRGF0ZVRpbWUiOiIyMDIxMDkyODEwMjM1MCIsImVidXlDb2RlIjoiMTAwMjEwODMwMDAwMDA1OTA5MSIsImZhY2VWYWx1ZSI6IjMwIiwib3V0VHJhZGVObyI6Ijg5MzkyMTA5MjgwMTYzOTgxIn0=&charset=utf-8&format=json&signType=sha256&timestamp=1483372334&appSecret=XXXXXXXXXXXX

最终签名值:bc151776f32a0eed26fd97696ece7e8102e5c1f8f594fbf8ddc392bd579693f1

接口清单及说明

接口调用名称 接口名称 接口适用场景 调用方向
queryCodeDetail 券查询接口 查询券关联的产品及活动详细信息 外部商户/渠道 调用易百
codeExchange 券兑换接口 用户在商户/渠道侧绑定或兑换易百券 外部商户/渠道 调用易百
codeStatusUpdate 券状态变更 外部渠道调易百做券状态更新,如 作废、延期、冻结解冻等,更多类型见接口定义 外部商户/渠道 调用易百
verify 券核销接口 核销券,该接口成功后券为 “已使用” 外部商户/渠道 调用易百
verifyVoid 券核销撤销接口 回退核销交易,该接口成功后券为 “可使用” 外部商户/渠道 调用易百

券状态变更通知 券状态发生变更时易百通知渠道/商户,如 作废、延期、冻结等,详情见接口定义 易百调用 外部商户/渠道,需商户/渠道向易百提供回调URL

公共参数

请求公共参数

参数名 说明 类型 是否必填 备注
appKey 由易百分配 String(32)
sign 签名值 String(400)
timestamp 时间戳(毫秒) Number(13)
bizContent 业务参数集合

返回公共参数

参数名 说明 类型 是否必填 备注
returnCode 返回码 String(20) 00: 成功 其他为失败或异常
returnMsg 返回描述 String(200)
data 具体的交易请求返回结果 Object