店铺购买应用后,使用应用生成的活动页、会员页等可通过此接口导入其店铺内,并可直接投放至站内各页面店铺楼层中
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
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授权方式为必填参数 |
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
decoPageIp | String | Y | //www.suning.com | 该应用的设置页的地址 |
pageType | String | Y | 会员 memIndex ; 抽奖 draw ;签到打卡 daka ; 其他 other | 页面类型,支持会员页、抽奖页、打卡页以及其他活动页 |
pageName | String | Y | XX会员页 | 页面名称,店铺装修后台-页面管理菜单中的展示名称 |
showPageIp | String | Y | //www.suning.com | 展示页地址,面向消费者的前台页面访问地址 |
serverId | String | Y | 1008722 | 服务市场的服务编码,用来查询服务订购有效期,过期后将不再投放 |
deliveryList | String | N | ||
channel | String | N | 03 | 投放渠道,支持将页面投放至以下位置,包括:01支付成功页店铺楼层、03物流页店铺楼层、04确认收货页店铺楼层、06商品详情页店铺楼层、1036移动店铺首页引导弹窗、1037移动店铺首页悬浮图标。页面类型为会员页时除上述渠道外,还可投放至1002移动店铺导航会员tab,替代原有官方会员页 |
posterUrl | String | N | //www.suning.com | 海报地址,投放渠道为06商品详情页店铺楼层时必传,图片尺寸为678*180(px) |
posterStartTime | String | N | 2020-03-01 12:03:30 | 投放海报的展示生效时间,投放渠道为四级页时可填,不填默认取当前时间 |
posterEndTime | String | N | 2020-03-31 00:00:00 | 投放海报的展示失效时间,投放渠道为四级页时可填,不填默认取应用失效时间 |
guidePicUrl | String | N | //www.suning.com | 引导弹窗图地址,投放渠道为1036引导弹窗时必传,图片尺寸宽为590px,高度为750px |
floatIconUrl | String | N | //www.suning.com | 悬浮图标地址,投放渠道为1037悬浮图标时必传,图片尺寸为210*210(px) |
deliveryIconUrl | String | N | //www.suning.com | 投放图标地址,投放渠道为01、03、04时必传,图片尺寸为100*100(px) |
deliveryTitle | String | N | 诚邀您加入店铺XX会员 | 投放标题,投放渠道为01、03、04时必传,最多12个字 |
deliveryDesc | String | N | 立即入会,享受专属会员福利 | 投放描述,投放渠道为01、03、04时必传,最多15个字 |
deliveryStatus | String | N | 0 | 投放活动状态,投放渠道为确认收货页店铺楼层、物流页店铺楼层时可填,支持投放生效和投放失效,默认为投放生效,0:失效,1:生效 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
success | String | Y | 处理标识,Y成功,N失败 |
signUrl | String | //shdspre.cnsuning.com/shds-web/positiveNew/wap/page/deco/loadPageMgr.action?showArea=deliveryPageMgr | 《免责声明》签署地址,处理标识为N时返回 |
<sn_request> <sn_body> <addDelivery> <deliveryList> <posterUrl>//www.suning.com</posterUrl> <posterEndTime>2020-03-31 00:00:00</posterEndTime> <deliveryTitle>诚邀您加入店铺XX会员</deliveryTitle> <channel>03</channel> <posterStartTime>2020-03-01 12:03:30</posterStartTime> <deliveryIconUrl>//www.suning.com</deliveryIconUrl> <deliveryDesc>立即入会,享受专属会员福利</deliveryDesc> <guidePicUrl>//www.suning.com</guidePicUrl> <floatIconUrl>//www.suning.com</floatIconUrl> <deliveryStatus>0</deliveryStatus> </deliveryList> <decoPageIp>//www.suning.com</decoPageIp> <pageType>会员 memIndex ; 抽奖 draw ;签到打卡 daka ; 其他 other</pageType> <pageName>XX会员页</pageName> <serverId>1008722</serverId> <showPageIp>//www.suning.com</showPageIp> </addDelivery> </sn_body> </sn_request>
{ "sn_request": { "sn_body": { "addDelivery": { "deliveryList": [ { "posterUrl": "//www.suning.com", "posterEndTime": "2020-03-31 00:00:00", "deliveryTitle": "诚邀您加入店铺XX会员", "channel": "03", "posterStartTime": "2020-03-01 12:03:30", "deliveryIconUrl": "//www.suning.com", "deliveryDesc": "立即入会,享受专属会员福利", "guidePicUrl": "//www.suning.com", "floatIconUrl": "//www.suning.com", "deliveryStatus": "0" } ], "decoPageIp": "//www.suning.com", "pageType": "会员 memIndex ; 抽奖 draw ;签到打卡 daka ; 其他 other", "pageName": "XX会员页", "serverId": "1008722", "showPageIp": "//www.suning.com" } } } }
<sn_responseContent> <sn_body> <addDelivery> <success>Y</success> <signUrl>//shdspre.cnsuning.com/shds-web/positiveNew/wap/page/deco/loadPageMgr.action?showArea=deliveryPageMgr</signUrl> </addDelivery> </sn_body> </sn_responseContent>
{ "sn_responseContent": { "sn_body": { "addDelivery": { "success": "Y", "signUrl": "//shdspre.cnsuning.com/shds-web/positiveNew/wap/page/deco/loadPageMgr.action?showArea=deliveryPageMgr" } } } }
异常码 | 错误描述 | 解决方案 |
---|---|---|
biz.custom.adddelivery.missing-parameter:* | 参数必填 | 请检查此参数的值,*号表示参数字段名 |
biz.custom.adddelivery.enumeration-error:* | 参数的可选值错误 | 请检查此参数的值,*号表示参数字段名 |
biz.custom.adddelivery.length-overlong:* | 参数的值超过规定长度 | 请检查此参数的值,*号表示参数字段名 |
isp.sys.service.unavailable.shds | 服务不可用 | 请联系苏宁技术人员 |
biz.custom.adddelivery.invalid-biz:101 | 当前应用已过有效期 | 请续费后投放 |
biz.custom.adddelivery.invalid-biz:102 | 移动店铺在用首页未装修引导弹窗模块 | 请商户到装修后台为移动端在用首页添加引导弹窗 |
biz.custom.adddelivery.invalid-biz:103 | 移动店铺在用首页未装修悬浮图标模块 | 请商户到装修后台为移动端在用首页添加悬浮图标 |
biz.custom.adddelivery.invalid-biz:104 | 当前商户不存在 | 请联系苏宁技术人员 |
biz.custom.adddelivery.invalid-biz:105 | 移动店铺在用首页未装修导航模块 | 请商户到装修后台移动端在用首页重新保存导航模块 |
biz.custom.adddelivery.invalid-biz:106 | 投放文案中存在敏感词 | 请调整文案后重新投放 |
biz.custom.adddelivery.invalid-biz:107 | 投放失败,当前店铺中生效的服务非本次投放的服务 | 请调整后重新投放 |
异常码 | 错误描述 | 解决方案 |
---|---|---|
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位 |