• 小白接口
  • 我的API
    • MyAPI(接口DIY,中文接口编程)
    • 私人定制API(由平台开发)
    • API在线测试
    • 免费创建我的接口
  • 应用API
    • 会员模块 重要
    • 数据统计模块 剩余流量
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 配置模块
  • 数据库API
    • 表单数据接口 [通用版] 开发必备
    • 表单结构API
    • 程序化数据API
    • MySQL/PostgreSQL API [直连版]
    • Sql Server API [数据库配置]
    • Sql Server API [存储过程]
    • Sql Server API [数据库操作]
  • 常用API
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 昵称API
    • 密码API
    • 模拟数据API
    • 日期API
    • 唯一ID生成API
    • 快递API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
  • 教程
  • API开发
    • 接口源码库 推荐
    • 接口DIY (低代码开发)
    • AI写接口
  • 登录
  • 注册



YesApi 接口文档

JWT令牌刷新 v1.15

接口路径(新):http://api.yesapi.cn/api/SVIP/Sba7iee_MyApi/ARefreshToken

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Sba7iee_MyApi.ARefreshToken

接口描述: JWT令牌刷新

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
refreshToken字符串必须refreshToken

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "accessToken刷新成功",
        "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wveWVzYXBpLmJhZmFuZy5vcmcuY24iLCJhdWQiOiJiYWZhbmciLCJzdWIiOiIxMSIsImlhdCI6MTcyODUzNjcyMCwiZXhwIjoxNzI4NTM2NzQwLCJ0eXBlIjoiYWNjZXNzIn0.Qtzw-weR1JIu5aV0Tvtkx2eUHMBD7d2xAUjEfV8ZzJI",
        "refreshToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wveWVzYXBpLmJhZmFuZy5vcmcuY24iLCJhdWQiOiJiYWZhbmciLCJzdWIiOiIxMSIsImlhdCI6MTcyODUzNjcyMCwiZXhwIjoxNzMxMTI4NzIwLCJ0eXBlIjoicmVmcmVzaCJ9.ilenP-lUiHmQF4LrwUB7Ie5P_3A_ESZiVjoF4qIQaPY",
        "expires": 1728536740
    },
    "msg": "",
    "_t": 1728536720,
    "_auth": "79eaa973d20094fbf966c0933a10ecb3"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code字符串错误代码:0成功,2refreshToken验证失败
data.err_msg字符串错误提示
data.accessToken字符串刷新后的accessToken
data.refreshToken字符串刷新后的refreshToken
data.expires字符串access_token过期时间戳
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

创建数据接口-通用版 v1.2

接口路径(新):http://api.yesapi.cn/api/SVIP/Sba7iee_MyApi/ACreate

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Sba7iee_MyApi.ACreate

接口描述: 通用创建数据接口,同时支持在自定义数据表单中添加一个【非重复】新数据,添加的字段应先在后台进行添加。即当数据不存在时则创建,当数据已存在时不进行任何操作。

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
model_name字符串必须要插入数据的模型(表)名称。必须是由字母、数字和下划线组成的有效标识符。
accessToken字符串必须访问令牌,用于验证用户身份和权限。
insert_data字符串JSON格式必须要插入的数据json,其中键为字段名,值为对应的数据。示例:{"role_name":"41","role_code":"12"}
check_field字符串JSON格式可选用于检查重复数据的字段数组。如果提供此参数,系统会在插入新数据前检查是否已存在具有相同指定字段值的记录。注意:insert_data数据中必须包含此字段的数据,用作检测重复的依据。多个检测字段用英文逗号分割。例如:check_field=["name","age"],表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在insert_data参数中传整型参数。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例
{
    "success": true,
    "err_code": 0,
    "err_msg": "",
    "id": "14"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.success布尔型操作是否成功,true表示成功,false表示失败
data.err_code整型错误代码,0表示无错误,其他值表示有错误发生
data.err_msg字符串错误信息,成功是为空,当操作失败时提供详细说明
data.id整型新插入记录的ID,仅在插入成功时返回
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

删除数据接口-通用版 v1.2

接口路径(新):http://api.yesapi.cn/api/SVIP/Sba7iee_MyApi/ADelete

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Sba7iee_MyApi.ADelete

接口描述: 根据ID精确或批量删除数据接口

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
model_name字符串必须要操作的表单名称
accessToken字符串必须用户访问令牌
ids字符串JSON格式必须要删除的记录ID数组,可以是以下格式之一:删除单个ID示例: [1] ,删除多个ID示例: [1, 2, 3]

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例
{
    "success": true,
    "err_code": 0,
    "err_msg": "",
    "delete_row": 1
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.success布尔型操作是否成功
data.err_code整型错误代码(0表示无错误)
data.err_msg字符串错误信息(成功是为空)
data.delete_row整型成功删除的记录数量
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

更新数据接口-通用版 v1.2

接口路径(新):http://api.yesapi.cn/api/SVIP/Sba7iee_MyApi/AUpdate

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Sba7iee_MyApi.AUpdate

接口描述: 更新数据接口-通用版 v1.2

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
accessToken字符串必须用户访问令牌,用于身份验证
model_name字符串必须要更新的数据表名称
id整型必须待更新的数据ID
update_data字符串JSON格式必须json格式包含要更新的字段和对应的新值。只需包含要更新的字段,不需要更新的字段可以省略。示例:{ "title": "更新后的文章标题", "content": "这是更新后的文章内容。", "category_id": 3, "is_published": true, "tags": ["技术", "编程", "PHP"], "view_count": 100 }

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例
{
    "success": true,
    "err_code": 0,
    "err_msg": "",
    "update_row": 1
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.success布尔型表示操作是否成功
data.err_code整型错误代码,0表示无错误
data.err_msg字符串错误信息,成功时为空字符串
data.update_row整型更新影响的行数
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

用户登录 v1.27

接口路径(新):http://api.yesapi.cn/api/SVIP/Sba7iee_MyApi/ALogin

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Sba7iee_MyApi.ALogin

接口描述: 登录接口,登录成功后返回用户信息和Token

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
account字符串必须admin用户名或者手机号
password字符串必须32位MD5加密后的密码

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例
{
    "success": true,
    "err_code": 0,
    "err_msg": "",
    "data": {
        "user_id": 1,
        "username": "admin",
        "nickname": "管理员",
        "sex": "男",
        "phone": "13927496288",
        "avatar": "",
        "roles": [
            "admin",
            "sales"
        ],
        "permissions": [
            "*:*:*"
        ],
        "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wveWVzYXBpLmJhZmFuZy5vcmcuY24iLCJhdWQiOiJiYWZhbmciLCJpYXQiOjE3Mjg3MjkxODEsImV4cCI6MTcyOTMzMzk4MSwidHlwZSI6ImFjY2VzcyIsImlkIjoxLCJ1c2VybmFtZSI6ImFkbWluIiwicGhvbmUiOiIxMzkyNzQ5NjI4OCJ9.g6gqpHCENogsFCYhxjjNbKSBuWfKitX2bj1bLgFRXYI",
        "refreshToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wveWVzYXBpLmJhZmFuZy5vcmcuY24iLCJhdWQiOiJiYWZhbmciLCJpYXQiOjE3Mjg3MjkxODEsImV4cCI6MTczMTMyMTE4MSwidHlwZSI6InJlZnJlc2giLCJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBob25lIjoiMTM5Mjc0OTYyODgifQ.9vkaRSdRSdQsmuWTe1TDFYfPqg2UFnwCyVBiNlEOzWk",
        "expires": 1729333981
    }
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.success字符串是否成功
data.err_code字符串错误代码:0成功
data.err_msg字符串错误描述
data.accessToken字符串验证token
data.refreshToken字符串刷新token
data.expires字符串Token过期时间
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

获取数据接口-通用版 v1.5

接口路径(新):http://api.yesapi.cn/api/SVIP/Sba7iee_MyApi/AGetList

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Sba7iee_MyApi.AGetList

接口描述: 根据搜索条件,分页获取检验项目数据列表,支持排序、搜索

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
page整型可选1最小:1第几页
perpage整型可选10最小:1;最大:10000分页数量
model_name字符串必须指定要查询的数据库表名。示例: "Products"
accessToken字符串必须用户的访问令牌,用于验证用户身份和权限。示例: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
conditions字符串JSON格式可选用于设置查询的过滤条件。键为字段名,值为要匹配的具体值。支持简单的等值匹配。对于复杂的条件(如大于、小于、IN 等),请直接使用原生 SQL 语法字符串作为键。/n示例: { "product_category < ?": 10, "product_lab": 1, "settlement_price < ?": 500, "standard_charge > ?": 100 }。同时模糊匹配多个字段示例:{"product_name LIKE ? OR clinical_app LIKE ?":["%关键词%","%关键词%"]}
order字符串JSON格式可选指定结果的排序规则。每个数组元素是一个字符串,包含字段名和排序方向(ASC 或 DESC)。示例: ["created_at DESC", "name ASC"]
fields字符串JSON格式可选用于指定要返回的字段列表。如果不提供,默认返回所有字段('')。每个数组元素应该是一个字段名。出于安全考虑,字段名会被过滤,只保留字母、数字和下划线。示例: ["id", "name", "created_at"]

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.success字符串成功true,失败false
data.items字符串数据列表,失败时返回空数组
data.total整型总数
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

特别注意:当前 api.yesapi.cn 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次