星河免费领券接口
返回结果参考resultFlag此字段
当resultFlag为1时,领券成功,返回具体的券信息
当resultFlag为0时,领券失败,具体失败原因参考failMessage字段
当resultFlag为3时,触发风控,需用户操作滑块验证。此时出参serialNo(请求流水号)、valiNo(业务唯一标识)、ticket(验证码平台tickect)将不为空,
前端根据ticket获取验证码token,将验证码token、请求流水号、业务唯一标识分别赋值给idfToken、serialNo、valiNo,其余必填参数保持不变再次调用此接口重新领券。
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
appMethod | String | Y | suning.custom.category.query | 方法名 |
appRequestTime | String | Y | 2012-04-25 20:23:30 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,例如:2012-04-25 20:23:30。API服务端允许客户端请求时间误差为10分钟。 |
format | String | N | XML | 默认xml,可指定格式为xml,json |
appKey | String | Y | b0c332a133c102765f39de********** | 分配给应用的访问令牌 |
versionNo | String | Y | v1.2 | API的版本,目前为v1.2版本 |
signInfo | String | Y | 460d7ff15b073e463125b4********** | appSecret,appMethod ,appRequestTime, appKey, versionNo, 请求报文base64加密后的数据顺序MD5(32位小写),其中appSecret为appKey对应的密钥 |
access_token | String | N | a1c5c62b08df3a3cbf7efd********** | 采用OAuth授权方式为必填参数 |
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
bonusTrigerId | String | Y | 3 | 励触发事件:3=免费领取 27=社会化营销活动奖 |
activityId | String | Y | 202004010001299290 | 券活动编码 |
activitySecretKey | String | Y | fXO2jW434G9EXtTUelN71K5U | 券秘钥,用于免费领券加密 |
snUnionId | String | N | bfb3ae009a31e98f4fa13ee41c6cbfb3ae01f9a31e9884fa | 混淆会员编码 |
terminalId | String | Y | 32 | 31:网站、 32:移动终端、 33:云信终端、 34:电话销售、 35:电视终端、 36:WAP、 37:电器门店 38:超市门店&苏宁小店 39:PPTV 40:商业广场 41:微店 42:分销渠道 43:小海狮APP 44:微仓渠道 47:红孩子门店 48:零售云 49:体育门店 59:苏鲜生微信商城 小程序、wap传36,易购app传32; |
cityId | String | N | 2 | 券活动没有限制城市可以不传; 券活动限制城市,必传 |
termiSys | String | Y | Windows | "Windows":Windows系统;"Linux":Linux系统;"Macos":Mac系统;"Android":安卓系统;"IOS":IOS系统;"HarmonyOS":鸿蒙系统 |
miniSource | String | N | 来源为易购app、WAP传空值;来源为易购小程序、达尔文小程序传"wechat" | |
dfpToken | String | Y | THc0gl1713dc37bc5gJJx2a58 | 操作设备指纹,前台传入 |
detect | String | Y | mmds_97fc62e6ea2c41abf7745f51622c67b3 | 人机识别码,前台传入 |
idfToken | String | N | THE0Kg17157544d8fsIFbb0d0___w7DDp8KLw75ow5MZbMOyImjCqsONBcOFw7hawqrCssOg | 验证码token |
serialNo | String | N | snyg612_39eaf0e06bbc54c387425bd94990f80c | 请求流水号 |
valiNo | String | N | 202004010001299291+6002318564 | 业务唯一标识,券id+会员id |
requestIp | String | Y | 10.96.193.66 | 取用户真实ip,且只传一个ip |
appVersion | String | N | 8.7.2.3 | APP外版本号,PC,WAP传空值"" |
memberId | String | N | 1234567890 | 会员编码 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
resultFlag | String | 0 | 领券操作结果 0 失败 1 成功 |
failCode | String | 1 | 操作结果为0时返回 |
failMessage | String | 活动奖励触发事件不一致 | 操作结果为0时返回 |
couponName | String | 免费券 | 操作类型为2时,操作结果为1时需有值 |
couponRulesShowMsg | String | 限平台全品类商品使用 | 操作类型为2时,操作结果为1时需有值 |
couponRuleCode | String | 1202004010001147821 | 操作类型为2时,操作结果为1时需有值 |
rewardsPreferential | String | 全额抵用 | 操作类型为2时,操作结果为1时需有值 |
couponType | String | 10001 | 10001 云券 10002 限品类云券 10003 店铺云券 10004 易券 10005 限品类易券 10006 店铺易券 10007 易付宝通用券 10008 易付宝专用券 10009 无敌券 10010 免运费券 10011 店铺免运费券 10012 SIM卡券 10013 自营无敌券 10014 大聚惠理财券 |
couponNo | String | C0000001696002 | 操作类型为2时,操作结果为1时需有值 |
couponAmount | String | 5.00 | 操作类型为1、2时,操作结果为1时需有值 |
couponBalance | String | 5.00 | 操作类型为2时,操作结果为1时需有值 |
isNextCoupon | String | 1 | 1:是 2:否 |
couponStartTime | String | 2020-04-04 10:36:42 | 操作类型为2时,操作结果为1时需有值 |
couponEndTime | String | 2020-04-04 10:36:42 | 操作类型为2时,操作结果为1时需有值 |
serialNo | String | snyg612_39eaf0e06bbc54c387425bd94990f80c | 请求流水号 |
valiNo | String | 202004010001299291+6002318564 | 业务唯一标识,券id+会员id |
ticket | String | 07d348ef6813d27fdc6ec9c57f64f98dd49a50dbb1ee0a66999b88b701db0d4590a98b02a55c7a20272c6d8a19c8b7858454582bcb6a5acf | 验证码平台tickect |
<sn_request> <sn_body> <getGalaxiecoupon> <activitySecretKey>fXO2jW434G9EXtTUelN71K5U</activitySecretKey> <idfToken>THE0Kg17157544d8fsIFbb0d0___w7DDp8KLw75ow5MZbMOyImjCqsONBcOFw7hawqrCssOg</idfToken> <appVersion>8.7.2.3</appVersion> <termiSys>Windows</termiSys> <dfpToken>THc0gl1713dc37bc5gJJx2a58</dfpToken> <detect>mmds_97fc62e6ea2c41abf7745f51622c67b3</detect> <miniSource>wechat</miniSource> <requestIp>10.96.193.66</requestIp> <cityId>2</cityId> <terminalId>32</terminalId> <valiNo>202004010001299291+6002318564</valiNo> <snUnionId>bfb3ae009a31e98f4fa13ee41c6cbfb3ae01f9a31e9884fa</snUnionId> <serialNo>snyg612_39eaf0e06bbc54c387425bd94990f80c</serialNo> <bonusTrigerId>3</bonusTrigerId> <activityId>202004010001299290</activityId> <memberId>1234567890</memberId> </getGalaxiecoupon> </sn_body> </sn_request>
{ "sn_request": { "sn_body": { "getGalaxiecoupon": { "activitySecretKey": "fXO2jW434G9EXtTUelN71K5U", "idfToken": "THE0Kg17157544d8fsIFbb0d0___w7DDp8KLw75ow5MZbMOyImjCqsONBcOFw7hawqrCssOg", "appVersion": "8.7.2.3", "termiSys": "Windows", "dfpToken": "THc0gl1713dc37bc5gJJx2a58", "detect": "mmds_97fc62e6ea2c41abf7745f51622c67b3", "miniSource": "wechat", "requestIp": "10.96.193.66", "cityId": "2", "terminalId": "32", "valiNo": "202004010001299291+6002318564", "snUnionId": "bfb3ae009a31e98f4fa13ee41c6cbfb3ae01f9a31e9884fa", "serialNo": "snyg612_39eaf0e06bbc54c387425bd94990f80c", "bonusTrigerId": "3", "activityId": "202004010001299290", "memberId": "1234567890" } } } }
<sn_responseContent> <sn_body> <getGalaxiecoupon> <couponName>免费券</couponName> <couponRulesShowMsg>限平台全品类商品使用</couponRulesShowMsg> <isNextCoupon>1</isNextCoupon> <ticket>07d348ef6813d27fdc6ec9c57f64f98dd49a50dbb1ee0a66999b88b701db0d4590a98b02a55c7a20272c6d8a19c8b7858454582bcb6a5acf</ticket> <couponRuleCode>1202004010001147821</couponRuleCode> <couponNo>C0000001696002</couponNo> <resultFlag>0</resultFlag> <rewardsPreferential>全额抵用</rewardsPreferential> <valiNo>202004010001299291+6002318564</valiNo> <failMessage>活动奖励触发事件不一致</failMessage> <serialNo>snyg612_39eaf0e06bbc54c387425bd94990f80c</serialNo> <couponEndTime>2020-04-04 10:36:42</couponEndTime> <couponBalance>5.00</couponBalance> <couponAmount>5.00</couponAmount> <couponType>10001</couponType> <couponStartTime>2020-04-04 10:36:42</couponStartTime> <failCode>1</failCode> </getGalaxiecoupon> </sn_body> </sn_responseContent>
{ "sn_responseContent": { "sn_body": { "getGalaxiecoupon": { "couponName": "免费券", "couponRulesShowMsg": "限平台全品类商品使用", "isNextCoupon": "1", "ticket": "07d348ef6813d27fdc6ec9c57f64f98dd49a50dbb1ee0a66999b88b701db0d4590a98b02a55c7a20272c6d8a19c8b7858454582bcb6a5acf", "couponRuleCode": "1202004010001147821", "couponNo": "C0000001696002", "resultFlag": "0", "rewardsPreferential": "全额抵用", "valiNo": "202004010001299291+6002318564", "failMessage": "活动奖励触发事件不一致", "serialNo": "snyg612_39eaf0e06bbc54c387425bd94990f80c", "couponEndTime": "2020-04-04 10:36:42", "couponBalance": "5.00", "couponAmount": "5.00", "couponType": "10001", "couponStartTime": "2020-04-04 10:36:42", "failCode": "1" } } } }
异常码 | 错误描述 | 解决方案 |
---|---|---|
biz.custom.getgalaxiecoupon.missing-parameter:* | 参数必填 | 请检查此参数的值,*号表示参数字段名 |
biz.custom.getgalaxiecoupon.length-overlong:* | 参数的值超过规定长度 | 请检查此参数的值,*号表示参数字段名 |
biz.handler.data-get:no-result | 查询没结果 | 请检查查询参数 |
isp.sys.service.unavailable.xhwmp | 服务不可用 | 请联系苏宁技术人员 |
异常码 | 错误描述 | 解决方案 |
---|---|---|
sys.check.user-permission:inexistence | 访问令牌不存在 | 更换访问令牌 |
sys.check.user-permission:overdue | 访问令牌已过期 | 请使用刷新令牌刷新 |
sys.check.api-permission:inexistence | Api方法不存在 | 请参考帮助中心 |
sys.check.api-permission:overdue | Api方法已过期 | 请参考帮助中心 |
sys.check.method-permission:authority | 无权操作此api | 确认是否有访问该方法权限 |
sys.auth.vendor-request:errory | 无权操作此供应商 | 请确认供应商编码是否正确 |
sys.controller.api-request:limit | Api请求受控 | 超过请求次数 |
sys.check.app-time:error | 请求参数错误api请求时间误差大 | 参考帮助中心 |
sys.check.request-params:error | 请求报文结构错误 | 参考帮助中心、日期格式等 |
sys.check.starttime-format:error | 请求开始时间错误 | 参考帮助中心、日期格式等 |
biz.handler.data-get:success | 业务数据查询成功 | 无 |
biz.handler.data-get:fail | 业务数据查询失败 | 检查请求条件 |
biz.handler.data-get:no-result | 业务数据结果为空 | 无 |
sys.check.pageno-format:error | pageNo格式错误,只允许1到99999之间的整数 | 检查pageNo输入是否有误 |
sys.check.pagesize-format:error | pageSize格式错误,只允许1到50之间的整数(订单相关是1到100) | 检查pageSize输入是否有误 |
sys.check.page-param:error | pageNo或者pageSize不在要求范围内,pageNo只允许1到99999之间的整数,pageSize只允许1到50之间的整数(订单相关是1到100) | 检查pageNo和pageSize输入是否有误 |
sys.check.miss-time:starttime | 不存在开始时间(节点) | 检查输入 |
sys.check.miss-time:endtime | 不存在结束时间(节点) | 检查输入 |
sys.check.starttime-value:null | 开始时间为空(值) | 检查输入 |
sys.check.endtime-value:null | 结束时间为空(值) | 检查输入 |
sys.check.starttime-format:error | 校验开始时间不合法,格式yyyy-MM-dd HH:mm:ss | 检查时间格式 |
sys.check.endtime-format:error | 校验结束时间不合法,格式yyyy-MM-dd HH:mm:ss | 检查时间格式 |
sys.check.query-time:error | 开始时间是否小于结束时间 | 检查开始和结束时间大小 |
sys.check.query-time:outofrange | 时间查询是否超出指定范围 | 检查时间范围 |
sys.check.app-sign:null | 签名信息为空 | 检查签名信息 |
sys.check.app-sign:error | 签名信息错误 | 检查签名信息 |
sys.check.missing-parameter:apiversion | API版本号未指定 | 检查API版本号 |
sys.check.missing-parameter:appRequestTime | 请求时间丢失 | 检查请求时间 |
sys.check.missing-nestElement:sn_body | 缺少sn_body节点 | 检查sn_body是否存在 |
sys.check.user-permission:inexistence | 用户key不存在 | 检查用户key是否存在 |
biz.handler.batch-handler:no-support | 非查询类API不支持批量操作 | 检查API类型 |
biz.handler.request-message:error | 查询类API输入多个业务节点 | 检查业务节点 |
sys.check.header-param:null | header参数为空 | 请检查header参数 |
sys.controller.api-access:limit | 访问限制 | 无 |
sys.controller.api-frequency:limit | 访问频率限制 | 无 |
sys.error.network:failure | 网络异常 | 无 |
sys.error.network-status:? | 响应失败 ?为状态码 | 无 |
sys.check.snunionid.length.is.not:48 | 混淆会员编码长度不是48位 | 使用转换器转换混淆会员编码规定要求混淆会员编码48位 |