通用接口要求和说明

一般的，除接口单独特定要求外，开放平台对外提供的接口均有以下通用设计约定

1. 接口路径统一前缀 https://gateway-smart.shouqianba.com/api/platform
2. 查询接口使用标准的 HTTP 协议，并强制要求使用 HTTPS
3. HTTP Method 为 POST，请求和响应参数均以 JSON 格式放在 Body 中，参数使用小驼峰式命名法（lower camel case）
4. 参数的类型包含 String（字符串）、Number（数字）、Array（数组/列表）、Object（对象），除此之外，在文档中，我们使用 Enum 关键字来标明枚举类型，表达该值的取值是在某几种值中选择的，但在实际 JSON 中使用 String 来表达枚举的值

5. 响应数据会统一进行包装，其中 code = 0 时代表响应成功，其余均为响应失败，code 值代表的报错释义可以在下方报错编码对照表中查看，message 可能会根据需要变更，请以 code 值为准。业务数据在 data 中体现

   1. 成功示例

      {
      "code": 0,
      "message": "查询成功",
      "data": {
          "bizData": {}
      }
      }
      

   2. 异常出参示例 1

      {
      "code": 40001,
      "message": "Token 无效"
      }
      

6. 不同的接口有不同的限流阈值，触发限流时会返回如下响应

   1. 限流异常响应

      {
      "code": 403,
      "message": "请求过快，请稍后再试"
      }
      

7. 一般情况下涉及到金额的部分，单位均是 "分"

8. 一般情况下涉及到时间戳的部分，单位均是 "毫秒"

接口顶级错误代码对照表