易赏平台接口规范

1. 概述
2. 前期准备
3. 接口业务说明
4. 接口技术实现方式
4.1 接口约定
4.2 生成签名(sign)
4.3 处理结果编码对照表
4.4 示例下载
5. 通用兑换接口
5.1 接口方式
5.2 接口调用字段要求
6. 非话费直充兑换接口
6.1 接口方式
6.2 接口参数定义
7. 话费流量包三网统一兑换接口
7.1 接口方式
7.2 接口参数定义
8. 任意充兑换接口
8.1 接口方式
8.2 接口参数定义
9. 实物奖品发货接口
9.1 接口方式
9.2 接口参数定义
10. 天猫购物券发放接口
10.1 接口方式
10.2 接口参数定义
11. 兑换结果查询接口
11.1 接口方式
11.2 接口参数定义
12. 兑换结果推送接口
12.1 接口方式
12.2 接口参数定义
13. 运营商查询接口
13.1 接口方式
13.2 接口参数定义
14. 手机号码充值限制查询接口
14.1 接口方式
14.2 接口参数定义
15. 库存数量查询接口
15.1 接口方式
15.2 接口参数定义
16. 免费奖品兑换接口
16.1 接口方式
16.2 接口参数定义
17. 京东奖品下单接口
17.1 接口方式
17.2 接口参数定义
18. 联系方式
19. 附录
19.1 串码状态说明

1. 概述

该接口文档适用于易赏跟用户的系统之间的奖品兑换(以下称:兑换接口),用户在易赏中下单购买奖品,在奖品入库后可以通过兑换接口完成奖品兑换。

2. 前期准备

易赏负责提供前期准备的参数(除 ip 白名单),并将参数发给用户系统,参数内容包括:

用户系统如需设置 ip 白名单,可将 ip 白名单发给易赏接口负责人,配置 ip白名单后,该订单只接收该 ip 的请求。

3. 接口业务说明

用户在调用兑换接口时,兑换接口负责将库存中的奖品串码返还给用户系统,同时将用户的奖品库中的该条奖品置为已经兑换的状态。

话费充值类和流量包类奖品可以在兑换时选择直充方式,选择直充方式,易赏将会把兑换奖品直接发给用户。

以上接口调用不可回退,相同的用户系统唯一订单号重复调用视为无效。

4. 接口技术实现方式

4.1 接口约定

提供源数据信息系统我们称作“ 接口信息发送系统” ,而通过一定方式接收别系统信息的系统我们称作“ 接口信息接收系统” 。这样的界定只在于同一个接口上,同一个业务系统可能会在某些接口中充当“ 接口信息发送系统” ,而在另外一些接口中充当“ 接口信息接收系统” 。

信息发送接口,由“ 接口信息发送系统” 将业务信息发送给“ 接口信息接收系统” ,由“ 接口信息接收系统” 进行业务处理。对于信息发送接口,一般是采用按需发送方式,所以可以采用实时或者定时两种方式,我们建议将业务处理过程和接口发送过程独立开,以免接口发送影响正常业务的性能和响应时间,甚至导致正常业务出错。对于这种接口,我们要求“ 接口信息发送系统” 在发送失败的时候能够进行重发,保证不漏不重;而“ 接口信息接收系统” 需要对信息的有效性、完整性进行校验。

对于一次接口过程中,应该保证事务的完整性,即如果出错的话,应该将业务相关处理完全回滚;另外,接口的结果必须是全部成功或者失败,不能部分进行业务处理。

4.2 生成签名(sign)

将接口请求参数(sign除外)按照参数名ASCII顺序,将所有参数值(sign除外)相加组成新的字符串,将该字符串与秘钥key组合后,通过md5加密后生成32位小写字符串。

示例:
秘钥key=12345678abcdefgh
请求url:http://api.1shang.com/mall-api/service/apiService?service=getAward&userId=1&orderId=1&prizeId=2&prizePriceTypeId=3&phone=18600000000&customOrderCode=0000000001&sign=1234abcd1234abcd1234abcd1234abcd

将请求参数排序:  
	customOrderCode=0000000001
	orderId=1
	phone=18600000000
	prizeId=2
	prizePriceTypeId=3
	service=getAward
	userId=1

将参数值组合:  
	String str = "0000000001"+"1"+"18600000000"+"2"+"3"+"getAward"+"1"
	结果:000000000111860000000023getAward1

生成sign:  
	String sign=md5("000000000111860000000023getAward1"+"12345678abcdefgh")

java示例:
	String key="12345678abcdefgh";//用户秘钥
	Map<String,String> map = new HashMap<String,String>();
	map.put("service","getAward");
	map.put("userId","1");
	map.put("orderId","1");
	map.put("prizeId","2");
	map.put("prizePriceTypeId","3");
	map.put("phone","18600000000");
	map.put("customOrderCode","0000000001");

	String[] nameArr = map.keySet().toArray(new String[]{});
	java.util.Arrays.sort(nameArr);
	StringBuilder builder = new StringBuilder();
	for(String name:nameArr){
		if("sign".equals(name)) continue;
		if(map.get(name) == null) continue;
		builder.append(map.get(name));
	}
	String plainText = builder.toString()+key;
	String sign = null;
	//MD5
	try {
		java.security.MessageDigest md = java.security.MessageDigest.getInstance("MD5");
		md.update(plainText.getBytes("UTF-8"));
		byte b[] = md.digest();
		int i;
		StringBuffer buf = new StringBuffer("");
		for (int offset = 0; offset < b.length; offset++) {
			i = b[offset];
			if (i < 0)
				i += 256;
			if (i < 16)
				buf.append("0");
			buf.append(Integer.toHexString(i));
		}
		sign = buf.toString();
	} catch (Exception e) {
		e.printStackTrace();
	}

		

4.3 处理结果编码对照表

编码 说明
0手机号码错误
1奖品 id 错误
2用户 id 错误
3面值 id 错误
4订单 id 错误
5第三方唯一订单 id 错误
6兑换数量错误
7sign 参数为空
8 sign 校验失败
9Operation 错误
11customOrderCode 为空
12customOrderCode 不存在
13移动奖品 id 缺失或错误
14移动奖品面值 id 缺失或错误
15电信奖品 id 缺失或错误
16电信面值 id 缺失或错误
17联通奖品 id 缺失或错误
18联通面值 id 缺失或错误
19未知供应商
28订单 id 和用户 id 匹配错误
31name 错误
32银行名错误
33银行卡号错误
34支行名为空或者超过50个字符
35省份名为空或者超过20个字符
36城市名为空或者超过20个字符
37订单已关闭或已删除
38订单下奖品已删除
40账号正在初始化。提交了错误的参数userId可能会返回该错误码。
41库存正在初始化。提交错误的参数orderId可能会返回该错误码。
47Count 数量过大,不超过 2 个
50奖品库存异常。订单已经生成,但是还没有支付。
51奖品库存不足。订单下的奖品已经消耗完。
52奖品库存日期异常
53奖品库存兑换量不足
54直冲接口异常
56customOrderCode 重复。同一个订单下,customOrderCode已经提交过一次,并且已经返回成功。如果再次使用相同的customOrderCode提交,则会返回该错误码。
58多个相同 customOrderCode 同时提交。同一个订单下,已经有一个线程提交了customOrderCode,还没有响应结果,如果其他线程在返回结果前也使用这个customOrderCode请求,后者会返回58.
59奖品不存在。提交的prizeId不是有效的。
60customOrderCode 长度超过 32 位
62发货地址错误
63备注字段超过最大长度
100Api 请求失败
120Ip 验证错误。当前订单设置了白名单,并且提交请求的ip不在白名单中,会返回当前错误码。
121话费充值 一次只能充一个串码
122该奖品不能直冲
123实物奖品不能兑换
124该奖品无法使用当前服务。某些奖品被限定只能调用某些指定的接口,如果调用了指定之外的接口,会抛出该错误。
125当日使用额超出限额。
126预存款不足。
117系统繁忙,请重新请求。当系统并发过高,或者资源不足,会直接返回该错误码。可以尝试减少并发或者稍等片刻再提交请求。
152不支持此面值
9994参数检验失败。可参考返回的message提示
9995服务不存在。检查请求的service是否与接口约定的service一致
9996数据解密失败
9997请求参数错误
9998请求数据格式错误
9999系统异常
10000调用成功
10001该奖品正在采购中
10002冻结金额不足

4.4 示例下载

java示例下载

php示例下载

python示例下载

5. 通用兑换接口(话费、流量包、影票、优惠券等)

5.1 接口方式

用户系统通过 HTTP 协议,调用易赏的兑换接口,并按照接口参数定义以GET/POST 传送相关数据。接口地址:

http://api.1shang.com/mall-api/service/apiService?service=getAward

5.2 接口参数定义

字符集为 UTF-8,数据以 http 的get/post 方式传输:

5.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id,由易赏平台提供 Number
orderId 订单 id,由易赏平台提供 Number
prizeId 奖品 id,由易赏平台提供 Number
prizePriceTypeId 奖品面值 id,由易赏平台提供 Number
phone 手机号码 Char(11)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
operation 直充标记,默认recharge。
recharge:话费、流量、转账金等充值类奖品充值,卡券类奖品获取卡号;
getCode:获取易赏平台串码。
varchar(8)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

5.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号(客户系统调用该接口的唯一标记) varchar(32)
code 消耗的串码 varchar(32)
couponCode 优惠码(优惠券类专用,如果优惠券包含密码,则使用英文半角逗号","分开) Varchar
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

a. 接口调用成功,返回 json 格式数据。

示例:成功返回 10000

{
    "customOrderCode":"85930274",
    "code":"HF5XH5CABMQMT",
    "couponCode":"",
    "result":"10000",
    "message":"请求成功"
}

b. 接口调用失败,返回 json 格式数据。

{
    "customOrderCode":"85930274",
    "code":"",
    "couponCode":"",
    "result":"9994",
    "message":"phone必填",
}

下载接口示例

6. 非话费直充兑换接口 (转账金、 Q 币类、加油卡、微信红包类)

6.1 接口方式

用户系统通过 HTTP 协议,调用易赏的非话费直充兑换接口,并按照接口参数定义以 GET/POST 传送相关数据。

接口地址:

http://api.1shang.com/mall-api/service/apiService?service=getBankCash

6.2 接口参数定义

字符集为 UTF-8,数据以 http 的 get/post 方式传输,get提交需要url转义.

6.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id,由易赏平台提供 Number
orderId 订单 id,由易赏平台提供 Number
prizeId 奖品 id,由易赏平台提供 Number
prizePriceTypeId 奖品面值 id,由易赏平台提供 Number
phone 手机号码 Char(11)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
name 用户名 Varchar(20) 否(转账金类必填)
bank 银行名 Varchar(20) 否(转账金类必填)
branch 银行支行 Varchar(50) 否(转账金类必填)
cardNumber 卡号(银行卡号、 QQ号码、加油卡号、微信openId等) Varchar(30)
province 开户行所在省份 Varchar(20) 否(转账金类必填)
city 开户行所在城市 Varchar(20) 否(转账金类必填)
operation 直充标记,默认recharge。
recharge:话费、流量、转账金等充值类奖品充值,卡券类奖品获取卡号;
getCode:获取易赏平台串码。
varchar(8)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

6.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号(用户系统调用该接口的唯一标记) Varchar(32)
code 消耗的串码 varchar(32)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{
    "customOrderCode":"85930274",
    "code":"HF5XH5CABMQMT",
    "result":"10000",
    "message":"请求成功"
}

b. 接口调用失败,返回 json 格式数据。

{
    "customOrderCode":"85930274",
    "code":"",
    "result":"9994",
    "message":"phone必填",
}

下载接口示例

7. 话费流量包三网统一兑换接口

7.1 接口方式

本接口为通用兑换接口扩展接口。判断手机号码所属运营商,然后兑换对应运营商的奖品。例如,电话号码18600000000运营商为联通,调用该接口时,会兑换ltPrizeId和ltPrizePriceTypeId对应的奖品。

用户系统通过 HTTP 协议,调用易赏的流量包兑换接口,并按照接口参数定义以GET/POST传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=getTraffic

7.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http的get/post方式传输:

7.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id,由易赏平台提供 Number
orderId 订单 id,由易赏平台提供 Number
ydPrizeId 移动奖品 id,由易赏平台提供 Number
ydPrizePriceTypeId 移动奖品面值 id,由易赏平台提供 Number
dxPrizeId 电信奖品 id,由易赏平台提供 Number
dxPrizePriceTypeId 电信奖品面值 id,由易赏平台提供 Number
ltPrizeId 联通奖品 id,由易赏平台提供 Number
ltPrizePriceTypeId 联通奖品面值 id,由易赏平台提供 Number
phone 手机号码 Char(11)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
operation 直充标记,默认recharge。
recharge:话费、流量、转账金等充值类奖品充值,卡券类奖品获取卡号;
getCode:获取易赏平台串码。
varchar(8)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

7.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号(用户系统调用该接口的唯一标记) Varchar(32)
code 消耗的串码 varchar(32)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{
    "customOrderCode":"85930274",
    "code":"HF5XH5CABMQMT",
    "result":"10000",
    "message":"请求成功"
}

b. 接口调用失败,返回 json 格式数据。

{
    "customOrderCode":"85930274",
    "code":"",
    "result":"9994",
    "message":"phone必填",
}

下载接口示例

8. 任意充兑换接口

8.1 接口方式

用户系统通过 HTTP 协议,调用易赏的兑换接口,并按照接口参数定义以GET/POST 传送相关数据。接口地址:

http://api.1shang.com/mall-api/service/apiService?service=freelyRecharge

8.2 接口参数定义

字符集为 UTF-8,数据以 http 的get/post 方式传输:

8.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id,由易赏平台提供 Number
orderId 订单 id,由易赏平台提供 Number
prizeId 奖品 id,由易赏平台提供 Number
faceValue 奖品面值,由易赏平台提供 Number
phone 手机号码 Char(11)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
cardNumber 卡号(QQ号码、微信openId) Varchar(30) 否(QB、微信红包类奖品必填)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

8.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号(客户系统调用该接口的唯一标记) varchar(32)
code 消耗的串码 varchar(32)
cost 扣款金额 Varchar
couponCode 优惠码(优惠券类专用,如果优惠券包含密码,则使用英文半角逗号","分开) Varchar
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

a. 接口调用成功,返回 json 格式数据。

示例:成功返回 10000

{
    "customOrderCode":"85930274",
    "code":"HF5XH5CABMQMT",
    "couponCode":"",
    "result":"10000",
    "message":"请求成功"
}

b. 接口调用失败,返回 json 格式数据。

{
        "customOrderCode":"85930274",
        "code":"",
        "couponCode":"",
        "result":"9994",
        "message":"phone必填",
        }

下载接口示例

9. 实物奖品发货接口

9.1 接口方式

用户系统通过 HTTP 协议,调用易赏的实物奖品发货接口,并按照接口参数定义以 GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=sendMaterialPrize

9.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

9.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 易赏平台账号 id,由易赏平台提供 Number
orderId 订单 id,由易赏平台提供 Number
prizeId 奖品 id,由易赏平台提供 Number
prizePriceTypeId 奖品面值 id,由易赏平台提供 Number
count 奖品数量,默认是:1 Number
phone 手机号码 varchar(11)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
province
例如:上海
varchar(30)
city
例如:上海市
varchar(30)
district 区、县
例如:闸北区
varchar(30)
address 详细地址、街道地址
例如:江场西路 160 号 11 层
varchar(255)
name 收件人姓名 varchar(20)
postcode 邮编 varchar(6)
remark 备注 Varchar(255)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

9.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号(用户系统调用该接口的唯一标记) Varchar(32)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{
    "customOrderCode":"85930274",
    "result":"10000",
    "message":"请求成功"
}

b. 接口调用失败,返回 json 格式数据。

{
    "customOrderCode":"85930274",
    "result":"9994",
    "message":"phone必填",
}

下载接口示例

10.天猫购物券发放接口

10.1 接口方式

用户系统通过 HTTP 协议,调用易赏的天猫购物券发放接口,并按照接口参数定义以 GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=sendTmall

10.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

10.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 易赏平台账号 id,由易赏平台提供 Number
orderId 订单 id,由易赏平台提供 Number
prizeId 奖品 id,由易赏平台提供 Number
prizePriceTypeId 奖品面值 id,由易赏平台提供 Number
phone 手机号码 varchar(11)
nick 淘宝帐号 varchar(40)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

10.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号(用户系统调用该接口的唯一标记) Varchar(32)
code 消耗的串码 varchar(32)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{
    "customOrderCode":"85930274",
    "code":"HF5XH5CABMQMT",
    "result":"10000",
    "message":"请求成功"
}

b. 接口调用失败,返回 json 格式数据。

{
    "customOrderCode":"85930274",
    "code":"",
    "result":"9994",
    "message":"phone必填",
}

下载接口示例

11. 兑换结果查询接口

11.1 接口方式

用户系统通过 HTTP 协议,调用易赏的状态查询接口,并按照接口参数定义以GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=queryStatus

11.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

11.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id Number
orderId 订单 id Number
prizeId 奖品 id Number 否(京东类必填)
customOrderCode 兑奖客户系统流水号(客户系统调用该接口的唯一标记) varchar(32)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

11.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 客户流水号 varchar(32)
status 奖品串码状态 varchar(16)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{"customOrderCode":"85930274","status":"API_GET","result":"10000","message":"请求成功"}

注: status 状态值如下

状态值 说明
API_GET 发放成功(非直充)
API_CHARGE_GET 发放成功(直充奖品,如:话费)
API_ERROR 发放失败(直充奖品,如:话费)
IN_CHARGE 处理中(直充奖品,如:话费)

接口调用失败,返回 json 格式数据。

{"customOrderCode":"85930274","status":"API_CHARGE_GET","result":"12","message":"customOrderCode不存在"}

失败后返回的 status 为空“” , result 返回处理结果编码(详情请见 章节4.3: 处理结果编码对照表)。

下载接口示例

12. 兑换结果推送接口

12.1 接口方式

用户调用奖品兑换接口成功, 当供应商返回状态后, 易赏平台将兑换结果推送给客户。 客户处理完成后,返回结果。

12.2 接口参数定义

推送数据,字符集为 UTF-8,数据以 http 的 post 方式传输:

12.2.1 接口参数

字段名称 字段说明 数据类型 是否必填
customOrderCode 兑奖客户系统流水号(客户系统调用该接口的唯一标记) varchar(32)
orderId 订单 id Number
code 消耗的串码 varchar(32)
phone 电话号码 varchar(11)
status 状态, 充值成功或者失败。 参考: 附件-串码状态说明。 varchar(16)
sign( 32 位小写) 校验码(规则见下方说明) Char(32)

校验码生成规则说明: MD5( customOrderCode+orderId+status+key), 32位小写字符串。

推送参数示例:

code=ABCDEFG123&orderId=1&customOrderCode=8F59K30H27J4&phone=18621652091&status=API_CHARGE_GET&sign=7af3abe9a156eb923d864256329f7117

12.2.2 接口应答信息

字段名称 字段说明 数据类型
customOrderCode 兑奖客户系统流水号(客户系统调用该接口的唯一标记) varchar(32)
orderId 订单 id Number
code 消耗的串码 varchar(32)
resultCode 客户响应结果:
接收成功: 10000
接收失败: 10001
推送重复: 10002
code 错误: 10003
customOrderCode 不存在:10004
phone 错误:10005
varchar(5)

返回 json 格式数据。

示例:成功返回 10000

{
    "customOrderCode":"85930274",
    "orderId":1,
    "code":"ABCDEFG123",
    "resultCode":"10000"
}

13. 手机号码运营商查询接口

13.1 接口方式

用户系统通过 HTTP 协议,调用易赏的查询接口,并按照接口参数定义以GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=queryOperator

13.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

13.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id Number
phone 手机号码 char(11)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

13.2.2 接口应答信息

字段名称 字段说明 数据类型
operator 供应商,例如:移动、电信、联通等 varchar(32)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{"operator":"移动","result":"10000","message":"请求成功"}

接口调用失败,返回 json 格式数据。

{"operator":"","result":"9994","message":"phone必填"}

result 返回处理结果编码(详情请见 章节4.3: 处理结果编码对照表)。

下载接口示例

14. 手机号码充值限制查询接口

14.1 接口方式

用户系统通过 HTTP 协议,调用易赏的查询接口,并按照接口参数定义以GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=canRecharge

14.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

14.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id Number
phone 手机号码 char(11)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

14.2.2 接口应答信息

字段名称 字段说明 数据类型
canRecharge 是否可以充值,yes:可以充值,no:不能充值 varchar(3)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{"canRecharge":"yes","result":"10000","message":"请求成功"}

接口调用失败,返回 json 格式数据。

{"canRecharge":"","result":"9994","message":"phone必填"}

result 返回处理结果编码(详情请见 章节4.3: 处理结果编码对照表)。

下载接口示例

15. 库存查询接口

15.1 接口方式

用户系统通过 HTTP 协议,调用易赏的查询接口,并按照接口参数定义以GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=queryStockInfo

15.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

15.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id Number
orderId 订单id Number
prizePriceTypeId 面值id Number
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

15.2.2 接口应答信息

字段名称 字段说明 数据类型
quantity 剩余库存数量 Number
usedQuantity 已使用库存数量 Number
money 自动购买订单预存款剩余金额,如果是非自动购买订单,返回0 Number
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{"quantity":100,"usedQuantity":100,"money":0,"result":"10000","message":"请求成功"}

接口调用失败,返回 json 格式数据。

{"quantity":0,"usedQuantity":0,"money":0,"result":"9994","message":"userId必填"}

result 返回处理结果编码(详情请见 章节4.3: 处理结果编码对照表)。

下载接口示例

16. 免费奖品兑换接口

16.1 接口方式

用户系统通过 HTTP 协议,调用易赏的查询接口,并按照接口参数定义以GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=freePrize

16.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

16.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
userId 账号 id Number
orderId 订单id Number
prizeId 奖品 id,由易赏平台提供 Number
prizePriceTypeId 面值id Number
phone 手机号码 Char(11)
customOrderCode 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 customOrderCode确认是否是同一笔交易。
varchar(32)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

16.2.2 接口应答信息

字段名称 字段说明 数据类型
code 返回的串码或固定链接 Number
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{"code":"ASFBSDFILDKFIDSL","result":"10000","message":"请求成功"}

接口调用失败,返回 json 格式数据。

{"code":"","result":"9994","message":"userId必填"}

result 返回处理结果编码(详情请见 章节4.3: 处理结果编码对照表)。

下载接口示例

17. 京东奖品下单接口

17.1 接口方式

用户系统通过 HTTP 协议,调用易赏的查询接口,并按照接口参数定义以GET/POST 传送相关数据。

接口地址:http://api.1shang.com/mall-api/service/apiService?service=submitJDOrder

17.2 接口参数定义

查询接口的数据传输,字符集为 UTF-8,数据以 http 的 get/post 方式传输:

17.2.1 接口调用字段要求

字段名称 字段说明 数据类型 是否必填
thirdOrder 客户流水号( 32 位以内字符串,客户系统调用该接口的唯一标记)
同一个orderId下以 thirdOrder确认是否是同一笔交易。
varchar(32)
prizeId 奖品 id,由易赏平台提供 Number
userId 账号 id Number
orderId 订单id Number
num 购买数量 Number
name 收货人姓名 Char(11)
province 一级地址(例浙江、上海) Char(11)
city 二级地址(例杭州市、闸北区) Char(11)
county 三级地址(例桐庐县、城区) Char(11)
town 四级地址(例江南镇) Char(11)
address 收货详细地址 Char(20)
mobile 手机号码 Char(11)
email 收件人邮箱 Char(20)
remark 备注 Char(20)
sign( 32 位小写) 校验码(查看sign生成规则 Char(32)

17.2.2 接口应答信息

字段名称 字段说明 数据类型
thirdOrder 第三方订单号 Varchar(32)
jdOrderId 京东订单id Varchar(32)
orderPrice 订单总售价 Varchar(32)
freight 运费 Varchar(32)
result 结果码(查看结果编码对照表 Varchar(5)
message 响应信息 Varchar(255)

接口调用成功,返回 json 格式数据。

示例:成功 resultCode 返回 10000

{"thirdOrder":"ASFBSDFILDKFIDSL","jdOrderId":"61119297274","orderPrice":"69.00",
            "freight":"6","result":"10000","message":"下单成功!"}

接口调用失败,返回 json 格式数据。

{"thirdOrder":"ASFBSDFILDKFIDSL","jdOrderId":"","orderPrice":"",
            "freight":"","result":"5","message":"第三方唯一订单id错误"}

result 返回处理结果编码(详情请见 章节4.3: 处理结果编码对照表)。

下载接口示例

18. 联系方式

联系人:刘全

QQ: 43079702

19. 附录

19.1 串码状态说明

状态值 说明
API_GET 发放成功(非直充)
API_CHARGE_GET 发放成功(直充奖品,如:话费)
API_ERROR 发放失败(直充奖品,如:话费)
IN_CHARGE 处理中(直充奖品,如:话费)