易约开放服务-API列表

API >API列表

返回API列表

SaleSaveOrderAPI
销售系统商户订单增加接口
SaleQueryOrderAPI
销售系统订单状态查询接口
SaleGetAccountAPI
销售系统账户余额查询接口
QueryAllProductAPI
销售系统查询所有商品列表接口
QueryProductDetailsAPI
销售系统查询指定商品详情接口
QueryAllCatalogAPI
销售系统查询全部目录接口
QueryAllCatalogAPI
回调接口说明

http://xxx.eyuesale.com/api/SaveOrder 销售系统虚拟订单增加API

功能说明:供销售系统与商家系统直接对接，商家将订单通过系统API将订单推送给销售/API系统进行充值,其中xxx为您在eyuesale的二级域名,或者您自行申请的域名(具体域名请咨询您的业务对接人)。

请求参数
响应参数
请求示例
响应示例
异常示例
业务异常码
公共异常码
FAQ(含回调说明)

请求频率：无限制，实际可能会根据系统压力做出调整,请以系统为准

强烈建议：对接商家请在初次对接的30分钟,1小时,2小时,首日等关键节点做好对账,以便尽早发现异常情况

请求方式：http协议,Get/Post

字符编码：UTF-8

提交数据格式：QueryString (eg:a=123&b=456)

返回数据格式：XML

请求参数

名称	类型	是否必须	示例值	描述
MerchantID	整数	Y	10001	商家编号
ProductNo	整数	Y	0	商品编号
Catagory	整数	N	94	商品目录
BuyNumber	整数	Y	1	购买数量（每个充值号购买数量）
ChargeAccount	字符	Y	123456789	充值号（多个用','分隔）
Sign	字符	Y	7fgydfgfdgfug	数字签名，把下列参数值按照顺序组成新字符串后计算MD5值(32位大小写均可),MD5（MerchantID+Catagory+BuyNumber+ChargeAccount+商户密钥）
OrderID	字符	N	fh7fyhfgh783hgugfgjfdg	订单编号,建议使用您系统内的流水号,不可重复
FaceValue	整数	N	0	订单面值(默认为0)(购买官方卡密商品必填)
GameName	字符	N	DNF点券	充值名称
Area	字符	N	北京1区	充值区域
Srv	字符	N	没有则留空或者不传	充值服务器
Otherinfo	字符	N	这是一个DNF订单	其他信息
ReturnUrl	字符	N	http://www.baidu.com/Callback	回调地址(详情请点击下方FAQ)
RechargeType	字符	N	通宝	充值类型名称,如寄售点数
BuyerIp	字符	N	111.111.111.111	买家IP地址
OrderType	整数	N	1	订单类型(1:官方卡密 0:接口供货)当购买官方卡密时必须传递参数为1
RoleName	字符	N	冰封の绝恋	(v1.6新增)充值角色名称
IdIsRepeatInAll	整数	N	1/0	(v230307新增)下游订单号幂等机制是否验证该商户下近3个月的全部订单(默认为0,如该订单号对应订单全部失败/全额退款后续同一个下游订单号可以重复增加订单,如传值1则仅允许增加唯一订单)

响应参数

名称	类型	示例值	描述
State	数字	0	返回状态值
State_Info	字符	请求成功\|成功1个\|失败0个	状态值｜返回备注信息
ChargeAccount	字符	123456789	充值帐号
SupOrderID	字符	2015101400180989711873289451	平台订单号
OrderID	字符	如果提交了自定义的订单号将显示在这里,否则为空	下游订单号

请求示例

响应示例

XML示例

复制全部代码

                                            
                                                                    <?xml version='1.0'?>
                                                                
                                                                    <Result>
                                                                
                                                                    <State>0</State>
                                                                
                                                                    <State_Info>请求成功|成功1个|失败0个</State_Info>
                                                                
                                                                    <Orders>
                                                                
                                                                    <Order>
                                                                
                                                                    <ChargeAccount>123456789</ChargeAccount>
                                                                
                                                                    <SupOrderID>2659752331001401</SupOrderID>
                                                                
                                                                    <OrderID></OrderID>
                                                                
                                                                    </Order>
                                                                
                                                                    </Orders>
                                                                
                                                                    </Result>

异常示例

XML示例

复制全部代码

                                            
                                                                    <?xml version='1.0'?>
                                                                
                                                                    <Result>
                                                                
                                                                    <State>117</State>
                                                                
                                                                    <State_Info>订单编号重复</State_Info>
                                                                
                                                                    </Result>

业务异常码

异常码	订单失败	错误描述	解决方案
2	未知	系统异常	查询订单状态,若无此订单,则为失败,如果有订单状态返回,则返回状态为该订单状态
10	未知	重复请求	查询此订单状态后根据查询的订单状态进行处理
11	未知	系统繁忙请稍候再试	查询此订单状态后根据查询的订单状态进行处理
12	是	商品编号和目录编号必须传递至少一项	商品编号和目录编号必须传递至少一项
13	未知	系统繁忙请稍候再试	查询此订单状态后根据查询的订单状态进行处理
14	未知	支付系统未知错误	查询此订单状态后根据查询的订单状态进行处理
102	是	商品目录不正确	请确保填写的商品目录格式为整数且存在
105	是	账号余额不足	请向平台汇款,以确保余额充足
106	是	无供货商品	该商品目录下无供货商品
107	是	进货价格大于进货上限	请确保订单金额足以购买该商品
108	是	商品目录应为数字	请确保商品目录为数字
109	是	购买数量应为数字	请确保购买数量为数字
110	是	商品编号应为数字	请确保商品编号为数字
111	是	充值账号最多为1000个	请确保充值账号数量小于等于1000个
112	是	最晚处理时间应大于当前时间	请确保最晚处理时间大于当前时间
113	是	最晚处理时间应在30分钟以后	请确保最晚处理时间在30分钟以后
114	是	禁售时间段内	请勿在禁售时间段内购买该商品
115	是	订单面值有误_应为整数	请确保订单面值填写正确
116	是	订单编号最长为32位	订单编号过长,可以选择不传此值
117	否	订单编号重复	等同于成功,可查询订单状态后进行处理
118	是	回调地址_格式有误	回调地址格式有误,回调地址应该是一个正确的网址
119	是	回调地址_最长为100字符	回调地址长度过长,请修改回调地址后再填写
120	是	购买数量不正确	购买数量不在许可范围内,请修改购买数量
121	是	风控拦截购买数量超限	修改风控设置或者稍后购买
122	是	风控拦截订单金额超限	修改风控设置或者稍后购买
123	是	风控拦截购买面值超限	修改风控设置或者稍后购买
124	是	风控拦截购买次数超限	修改风控设置或者稍后购买
125	是	风控拦截购买面值和次数同时超限	修改风控设置或者稍后购买
126	是	买家IP格式有误	请填写正确格式的IP地址
129	是	商品无定价	商品未定价,请勿继续购买此商品
130	是	商品已下架	购买的商品已下架,请勿继续购买此商品
131	是	商品已断货	购买的商品已断货,请勿继续购买此商品
132	是	商品编号和目录不符	请确保商品编号在该商品目录下
135	是	商品无可用库存	商品无可用库存,请勿继续购买该商品
136	是	订单支付总金额有误	请填写正确格式的支付金额,支付金额应该为数字
137	是	充值账号已加入黑名单	该充值账号已加入黑名单,请勿再提交该充值账号
138	是	此商品禁止购买	此商品禁止购买,请勿继续购买此商品
140	是	充值账号格式错误	请填写正确的充值账号,单个充值账号长度不得超过100位字符
141	是	商品价格发生变动请重新购买	商品价格发生变动请重新购买
142	是	当前区域不允许购买	下单区域限购,请更换下单IP或者放弃购买此商品
143	是	您无权购买此商品	您无权购买此商品,请勿继续购买此商品
146	是	订单面值与供货商品面值不符	订单面值必须是供货商品面值的整数倍
201	是	商品编号有误	请确保商品编号正确
202	是	订单数量不在范围内	可根据商品信息重新修改订单数量
206	是	商品可见范围限制	商品可见范围限制,请勿继续购买此商品

公共异常码

异常码	订单失败	错误描述	解决方案
0	否	成功	无需解决
1	是	失败	无需解决
3	是	参数有误	请检查参数的值
4	是	商家编号不存在	请确保商家编号是否正确填写,如果正确填写仍然出现此问题则联系管理员获取商家编号
5	是	密钥错误	如果加密不正确则查看加密方式/参数是否正确!如果确保加密正确,则联系管理员获取正确的密钥
6	是	商家编号应为数字	商家编号填写错误,应该填写数字格式
7	是	请求过于频繁	请适当增加2次请求的间隔
8	是	IP不在许可范围内	请联系管理员解决问题
9	是	无API权限	请联系管理员开通API权限
15	是	账号未验证	请联系管理员解决问题
16	是	商家已禁用	请联系管理员解决问题
128	是	系统暂时关闭请联系管理员	系统暂时关闭请联系管理员
144	是	当前公司已禁用	请联系管理员解决问题
401	是	商家状态有误	请联系管理员查询该商家状态是否正确

FAQ(回调说明在此)

有关回调地址说明:

1.如果向系统提交了回调地址则会在订单充值成功/失败的时候向指定的地址采用Get方式发送充值结果

2.为了保证网络通信的兼容性良好,请尽量采用http协议接收回调,不保证https协议回调的稳定性

响应参数：

名称	类型	示例值	描述
SupOrderID	数字	2015101400180989711873289451	系统内部订单号
OrderID	字符	s3rfdfkdfjdf043t4	下游自定义订单号
ChargeAccount	字符	123456789	充值帐号
Status	字符	可疑订单/充值成功/充值失败 ,utf-8编码返回	充值状态(所有的订单状态请参见sup后台)
DetailMsg	字符	充值失败	充值失败时会有具体失败原因,utf-8编码返回
Sign	字符	ecac7900f965a74f011facdfb36e244f	数字签名Md5(SupOrderID+OrderID+ Status+ key)
StatusNo	数字	0	充值状态的编号数字,跟上面的Status中文一一对应0:充值成功 1:充值失败 2:处理中 3:可疑订单
Sign2	字符	0	另外一组数字签名Md5(SupOrderID+OrderID+ StatusNo + key)
TradeAmount	字符	46.0000	订单金额
Cards	字符	0	卡密类订单的卡密信息类似这样的多组数据可以自行解析,[{'No':'2055029031001601','PassWord':'2010079641000701', 'ExpireTime':'2018-12-22 00:00:00'}]

特别注意:

1.计算此次的sign值的时候因为涉及到中文,所以请用utf-8编码

2.合作方收到请求后必须给我们返回"ok",大小写不限 ,否则系统将一直请求持续30分钟,请尽量在3秒钟内返回接收情况,多次回调超时过长的网络请求将被回调子系统自动放弃

3.订单在可疑/成功/失败的时候都会回调,也就是说有可能先收到可疑的状态通知,然后又收到成功/失败,所以要做好后续处理,不要收到可疑就直接放弃此订单的通知接收

4.如果部分开发语言对中文参与验签的时候跟我们系统返回总是不匹配,那请验签Sign2,这个不包含中文. 只要Sign和Sign2 里面有任意一个签名是正确的就说明请求合法有效