数据查询接口文档-YeXin

接口信息

请求地址:https://api.tics.top/search/

请求方式:GET

功能说明:查询指定数据表中的内容(支持精准/模糊匹配)

请求参数

参数名 必填 类型 说明
id String 数据表标识,多个ID用连字符分隔(例:1-2-3
data String 搜索关键字
fuzzyQuery Boolean 是否启用模糊查询(默认false),设为true时进行模糊匹配

返回格式

参数名 类型 说明
result String 请求结果,成功返回success,失败返回error
responseData Array 分组数据集合,包含两种类型:
  • simple - 独立数据(无关联)
  • relationGroup - 关联数据组
message String 请求失败时返回:包含错误信息

数据结构示例

{
    "result": "success",
    "responseData": [
        {
            "groupType": "simple",
            "groupData": {
                "main": [
                    {
                        "姓名": "张三",
                        "电话": "13111111111"
                    }
                ]
            }
        },
        {
            "groupType": "relationGroup",
            "groupData": {
                "main": [
                    {
                        "运单号": "YT123245613431",
                        "姓名": "李四"
                    }
                ],
                "relation": [
                    {
                        "运单号": "YT113343423423",
                        "姓名": "王五"
                    }
                ]
            }
        }
    ]
}

请求示例

模糊查询

https://api.tics.top/search/?id=1&data=张&fuzzyQuery=true

错误码说明

错误原因 HTTP 状态码 返回信息
请求方法非GET 405 请求方法错误
缺少参数 400 缺少id或data参数
请求频率过高 429 请求频繁,请稍候再试
查找范围过广 400 返回结果超过限制

注意事项

频率限制

注意