开放服务-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授权方式为必填参数

请求参数

名称	类型	是否必须	示例值	描述
sceneCode	String	N	COPYDETECT	应用场景编码。文案检测：COPYDETECT；条款检测： CLAUSEDETECT；评论检测：COMMENTDETECT；商品信息：COMMIDITY；豆芽文本：DOUYA；
tasks	String	N
dataId	String	Y	niinn	业务方唯一标识本段文本，内容安全原样返回
content	String	Y	第一名，纯天然，顶级	待检测的文本内容，建议对内容中JSON、表情符、HTML标签、UBB标签等做过滤，只传递纯文本，以减少误判概率。长度限制为1000(暂定)（有超长文本需求可以提需求）
cmmdtyCode	String	N	11761213455	需要审核的商品编码（仅商品使用，其他业务方忽略本字段）
supplierCode	String	N	R9009921	需要审核的商家编码（仅商品使用，其他业务方忽略本字段）

响应参数

名称	类型	示例值	描述
sceneCode	String	R100	应用场景编码，按请求原样返回
msg	String	ok	接口返回详细信息。【ok \| 其他状态暂未明确，根据开发需要再补充】
tasks	String
msg	String	ok	接口返回详细信息。【ok \| 其他状态暂未明确，根据开发需要再补充】
dataId	String	niinn	业务方唯一标识本段文本，按请求原样返回
content	String	第一名，纯天然，顶级	待检测的文本内容
results	String
dictName	String	IMCS_SP_BLACK_R100	命中的实际词库编码
priority	String	高	文本稽查目前返回为空
match	String	["第一名"]	返回命中了的敏感词，类型为List
scene	String	others	scene即管理平台上的“违规类型”字段，不配置的时候默认返回标签others，默认不开放给业务方配置。如有需要，联系产品进行配置。【normal正常，porn涉黄，terrorism暴恐，politic涉政，ADillegal广告法违禁，advertisement广告导流，contraband违禁信息，abuse辱骂，flood灌水，others其他，promotion促销词（仅商品）】（normal代表命中了关键词但是判定为良性的场景，其他取值都是不良场景）
label	String	ADillegal	命中敏感词时返回用户自定义的敏感词标签命中语义时可返回子场景分类（如果有子分类则返回，全部以"_"开头，例如涉政可以返回"_国家领导人/_敏感事件/_出逃官员"等，没有则返回_null）文本稽查目前返回为空，保留字段
resultCode	String	200	敏感词检测返回码，代表此条文本检测结果。【200 检测成功，命中了敏感词, 210 检测成功，未命中敏感词, 220 检测成功，疑似命中敏感词, 其他状态暂未明确，根据开发需要再补充】
interfaceCode	String	200	接口返回码，代表接口调用成功失败，不代表文本检测结果。文本检测结果请看task->code字段。【200 success \| 400 请求参数错误 \| 401 未授权的业务方其他状态暂未明确，根据开发需要再补充】
cmmdtyCode	String	""	需要审核的商品编码（仅商品使用，其他业务方忽略本字段），按请求原样返回
requestId	String	dce41d7cde1f4f2297dbdcac4543cfae06031652647499092	唯一标识本次请求，内容安全平台自动生成
supplierCode	String	""	需要审核的商家编码（仅商品使用，其他业务方忽略本字段），按请求原样返回

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <querySwrs>
      <sceneCode>COPYDETECT</sceneCode>
      <cmmdtyCode>11761213455</cmmdtyCode>
      <supplierCode>R9009921</supplierCode>
      <tasks>
        <dataId>niinn</dataId>
        <content>第一名，纯天然，顶级</content>
      </tasks>
    </querySwrs>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "querySwrs": {
        "sceneCode": "COPYDETECT",
        "cmmdtyCode": "11761213455",
        "supplierCode": "R9009921",
        "tasks": [
          {
            "dataId": "niinn",
            "content": "第一名，纯天然，顶级"
          }
        ]
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <querySwrs>
      <msg>ok</msg>
      <sceneCode>R100</sceneCode>
      <requestId>dce41d7cde1f4f2297dbdcac4543cfae06031652647499092</requestId>
      <cmmdtyCode>""</cmmdtyCode>
      <supplierCode>""</supplierCode>
      <interfaceCode>200</interfaceCode>
      <tasks>
        <msg>ok</msg>
        <dataId>niinn</dataId>
        <resultCode>200</resultCode>
        <results>
          <match>["第一名"]</match>
          <dictName>IMCS_SP_BLACK_R100</dictName>
          <label>ADillegal</label>
          <priority>高</priority>
          <scene>others</scene>
        </results>
        <content>第一名，纯天然，顶级</content>
      </tasks>
    </querySwrs>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_body": {
      "querySwrs": {
        "msg": "ok",
        "sceneCode": "R100",
        "requestId": "dce41d7cde1f4f2297dbdcac4543cfae06031652647499092",
        "cmmdtyCode": "\"\"",
        "supplierCode": "\"\"",
        "interfaceCode": "200",
        "tasks": [
          {
            "msg": "ok",
            "dataId": "niinn",
            "resultCode": "200",
            "results": [
              {
                "match": "[\"第一名\"]",
                "dictName": "IMCS_SP_BLACK_R100",
                "label": "ADillegal",
                "priority": "高",
                "scene": "others"
              }
            ],
            "content": "第一名，纯天然，顶级"
          }
        ]
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.queryswrs.length-overlong:*	参数的值超过规定长度	请检查此参数的值,*号表示参数字段名
biz.custom.queryswrs.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
biz.handler.data-get:no-result	查询没结果	请检查查询参数
isp.sys.service.unavailable.swrs	服务不可用	请联系苏宁技术人员
400	请求参数错误	请检查查询参数
410	未授权的业务方	请检查查询参数
500	服务不可用	请检查参数，一般是tasks参数不合法导致的

公共异常码

异常码	错误描述	解决方案
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