响应返回码

2024.06.27 10:51:31

    响应返回码(code)反映了易盾业务安全服务 API 调用和执行的概要结果。当返回码不为 200 时,表示请求未正常执行,返回码描述 (msg) 对该结果进行了细化补充,用户可根据返回码判断 API 的执行情况。 所有接口调用返回值均包含 code 和 msg 字段,code 为返回码值,msg 为返回码描述信息,返回码表如下:

    HTTP状态码 错误码 描述
    200 0 无异常
    200 415 签名校验错误
    200 419 参数校验错误,例如参数类型错误、参数值错误、必填项为空等
    200 430 qps超限
    200 421 验证码版本不匹配

    常见问题

    415-签名错误

    客户端和服务端计算签名的算法不一致造成的,详细的签名算法请参考官网文档,如出错请仔细检查下列条件:

    • 确保 secretId, secretKey, businessId 参数填写正确,注意 businessId 不是产品编号
    • http 请求的参数必须采用 form 表单格式,如果是自己拼接注意格式正确,不接受 json 格式的参数
    • 计算签名的字符串不需要进行 urlencode,但是 http 传输时需要将参数采用 utf-8 编辑进行 urlencode 传输
    • 额外传了文档中未提及的字段
      测试时,建议直接使用官网 demo 测试接口调用是否成功,如需修改,请参考官网 demo

    419-参数错误

    • 排查公共参数是否配置完全正确:
    • 排查传参模式是否为:post 模式,并且编码方式 Content-Type: application/x-www-form-urlencoded;charset=utf-8
      可能出现的情况:
      validate 值是随便填写的,绕过了前端,直接调用我们二次检验接口
      validate 重复调用或者过期,validate 只能校验一次且 20 分钟(默认)内有效
      后端把公共参数定义成 json 格式,即使是用 form 格式提交也会报错
      验证码 ID(captchaId)失效,比如试用过期
      user 字段必传的,可以传空
      某个参数名写错,比如字段 nonce 写成了 none、secretId 写成 sercetId 等
    Online Chat Tel:95163223 Free trial