开放服务-API列表

名称	类型	是否必须	示例值	描述
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	N	3	奖励触发事件编号(1=MSI校园用户认证成功发券 2=会员签到发券 3=免费领取 5=微信绑定账户发券 6=新人绑定快捷支付发券 7=抽奖 8=游戏 10=会员营销 11=MPS发券 18=分享福袋发券 21=0岁妈妈认证发券 22=闪拍发券 25=线下SIM卡券 27=社会化营销活动 28=易付宝送券 29=赔付补差发券 30=云钻兑换券 31=定向发券 32=补偿返券 33=差价补返 34=员工内购 35=客户端新人红包 36=电销专属渠道券 37=众筹 38=店+发券 39=试用发券 40=苏宁互联通信返券 41=新手任务发券 42=红掌柜发券 43=淘金币兑换券 44=微信发券 45=理财发券 46=红孩子母婴 47=APP推广注册送券 48=任性付发券 49=苏宁小店 50=彩票发券 52=网红直播平台发券 72=拼购发券 74=付费会员权益 80=凉生发券 81=O2O营销券 82=小店付费会员权益 94=滴滴发券 105=商家直赔券 113=券活动踢品赔付 126=百货虚销抵用券 143=小店新人券)
activityInfo	String	Y	[{activityId:权益活动ID,activitySecretKey:权益活动秘钥,bonusTrigerId:奖励触发事件编号},{activityId:权益活动ID,activitySecretKey:权益活动秘钥,bonusTrigerId:奖励触发事件编号}]	活动编码、活动秘钥及奖励触发事件编号 json格式
snUnionId	String	Y	bfb3ae009a31e98f4fa13ee41c6cbfb3ae01f9a31e9884fa	混淆会员编码
terminalId	String	Y	32	终端编码(31：易购PC 32：易购APP、 33：云信终端、 34：电话销售、 35：电视终端、 36：易购WAP、 37：电器门店 38：小店门店 39：PPTV 40：商业广场 41：微店 42：分销渠道 43：小海狮APP（已废弃） 44：微仓渠道 47：红孩子门店 48：零售云APP 49：体育门店 55：苏宁小店APP 56：苏宁小店WAP 57：苏宁小店小程序 59：苏鲜生微信商城 60：易购门店小程序 61：苏小团APP 62：帮客APP 63：苏鲜生超市门店 64：百货门店 65：苏宁小店APP（易购商品） 66：苏宁小店小程序（易购商品） 67：百货店小程序 68：门店代购 69：推客APP 70：红小宝小程序 71：苏皮士微信小程序 73：彩票门店 74：家乐福门店 75：家乐福扫码购 76：家乐福小程序)
cityId	String	N	200012090011	城市编号(券活动没有限制城市可以不传, 券活动限制城市必传)
termiSys	String	Y	IOS	终端系统(Windows系统：Windows Linux系统：Linux Mac系统：Macos 安卓系统：Android IOS系统：IOS 鸿蒙系统：HarmonyOS)
miniSource	String	Y	wechat	小程序来源(苏宁=suning 头条=toutiao 微信=wechat 百度=baidu 快应用=quickapp QQ=qq 支付宝=alipay 抖音=douyin)
dfpToken	String	Y	THc0gl1713dc37bc5gJJx2a58	设备Token
detect	String	Y	mmds_97fc62e6ea2c41abf7745f51622c67b3	人机采集标识
idfToken	String	N	THE0Kg17157544d8fsIFbb0d0___w7DDp8KLw75ow5MZbMOyImjCqsONBcOFw7hawqrCssOg	验证码token(返回参数resultFlag为3时必传)
serialNo	String	N	snyg612_39eaf0e06bbc54c387425bd94990f80c	事件流水号(返回参数resultFlag为3时必传)
valiNo	String	N	6002318564154563465	业务唯一标识(返回参数resultFlag为3时必传)

响应参数

名称	类型	示例值	描述
resultFlag	String	0 失败 1 成功 3 验证token	操作结果
failCode	String	20	失败编码
failMessage	String	风控拦截	失败信息
serialNo	String	snyg612_39eaf0e06bbc54c387425bd94990f80c	事件流水号
valiNo	String	6002318564154563465	业务唯一标识
ticket	String	07d348ef6813d27fdc6ec9c57f64f98dd49a50dbb1ee0a66999b88b701db0d4590a98b02a55c7a20272c6d8a19c8b7858454582bcb6a5acf	验证码ticket
couponResult	String	[{resultFlag:0,failCode:1,failMessage:活动奖励触发事件不一致,couponNo:202008070001375246,activityId:权益活动ID}]	领券返回结果数组

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <receiveGalaxiecoupon>
      <bonusTrigerId>3</bonusTrigerId>
      <idfToken>THE0Kg17157544d8fsIFbb0d0___w7DDp8KLw75ow5MZbMOyImjCqsONBcOFw7hawqrCssOg</idfToken>
      <termiSys>IOS</termiSys>
      <dfpToken>THc0gl1713dc37bc5gJJx2a58</dfpToken>
      <detect>mmds_97fc62e6ea2c41abf7745f51622c67b3</detect>
      <miniSource>wechat</miniSource>
      <cityId>200012090011</cityId>
      <terminalId>32</terminalId>
      <valiNo>6002318564154563465</valiNo>
      <activityInfo>[{activityId:权益活动ID,activitySecretKey:权益活动秘钥,bonusTrigerId:奖励触发事件编号},{activityId:权益活动ID,activitySecretKey:权益活动秘钥,bonusTrigerId:奖励触发事件编号}]	</activityInfo>
      <snUnionId>bfb3ae009a31e98f4fa13ee41c6cbfb3ae01f9a31e9884fa</snUnionId>
      <serialNo>snyg612_39eaf0e06bbc54c387425bd94990f80c</serialNo>
    </receiveGalaxiecoupon>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "receiveGalaxiecoupon": {
        "bonusTrigerId": "3",
        "idfToken": "THE0Kg17157544d8fsIFbb0d0___w7DDp8KLw75ow5MZbMOyImjCqsONBcOFw7hawqrCssOg",
        "termiSys": "IOS",
        "dfpToken": "THc0gl1713dc37bc5gJJx2a58",
        "detect": "mmds_97fc62e6ea2c41abf7745f51622c67b3",
        "miniSource": "wechat",
        "cityId": "200012090011",
        "terminalId": "32",
        "valiNo": "6002318564154563465",
        "activityInfo": "[{activityId:权益活动ID,activitySecretKey:权益活动秘钥,bonusTrigerId:奖励触发事件编号},{activityId:权益活动ID,activitySecretKey:权益活动秘钥,bonusTrigerId:奖励触发事件编号}]\t",
        "snUnionId": "bfb3ae009a31e98f4fa13ee41c6cbfb3ae01f9a31e9884fa",
        "serialNo": "snyg612_39eaf0e06bbc54c387425bd94990f80c"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <receiveGalaxiecoupon>
      <couponResult>[{resultFlag:0,failCode:1,failMessage:活动奖励触发事件不一致,couponNo:202008070001375246,activityId:权益活动ID}]</couponResult>
      <ticket>07d348ef6813d27fdc6ec9c57f64f98dd49a50dbb1ee0a66999b88b701db0d4590a98b02a55c7a20272c6d8a19c8b7858454582bcb6a5acf</ticket>
      <failCode>20</failCode>
      <resultFlag>0 失败   1 成功  3 验证token</resultFlag>
      <valiNo>6002318564154563465</valiNo>
      <failMessage>风控拦截</failMessage>
      <serialNo>snyg612_39eaf0e06bbc54c387425bd94990f80c</serialNo>
    </receiveGalaxiecoupon>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_body": {
      "receiveGalaxiecoupon": {
        "couponResult": "[{resultFlag:0,failCode:1,failMessage:活动奖励触发事件不一致,couponNo:202008070001375246,activityId:权益活动ID}]",
        "ticket": "07d348ef6813d27fdc6ec9c57f64f98dd49a50dbb1ee0a66999b88b701db0d4590a98b02a55c7a20272c6d8a19c8b7858454582bcb6a5acf",
        "failCode": "20",
        "resultFlag": "0 失败   1 成功  3 验证token",
        "valiNo": "6002318564154563465",
        "failMessage": "风控拦截",
        "serialNo": "snyg612_39eaf0e06bbc54c387425bd94990f80c"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

{
  "sn_responseContent": {
    "sn_error": {
      "error_code": "API异常码",
      "error_msg": "异常码中文描述"
    }
  }
}

业务异常码

异常码	错误描述	解决方案
biz.custom.receivegalaxiecoupon.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
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位

API工具

API TOOLS 在线测试工具异常码查询工具 SDK调用示例 SDK下载

FAQ