YesApi 接口文档

修改用户密码 v1.6

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/SGlimmer8087_MyApi/AUserPwdChange

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.SGlimmer8087_MyApi.AUserPwdChange

接口描述： 修改用户密码

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
user_id字符串必须
user_password字符串必须

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

创建皇田噪声检测 v1.3

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/SGlimmer8087_MyApi/ACreateHtnoisedetection

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.SGlimmer8087_MyApi.ACreateHtnoisedetection

接口描述： 插入一条新的检测数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
SN字符串必须@NULL生产流水号
DetectionTime字符串必须@NULL检测时间
DetectionData字符串必须@NULL检测数据

客户端请求示例

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

HTTP通用示例 
{
    "err_code": 0,
    "err_msg": "",
    "id": "22"
}

接口返回及数据结构

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

数据检索 v1.19

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/SGlimmer8087_MyApi/AAQueryHtnoisedetection

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.SGlimmer8087_MyApi.AAQueryHtnoisedetection

接口描述： 根据输入的SN号或者时间范围搜索，搜索后显示搜索的数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
SN字符串可选
StartTime字符串可选
PageSize字符串必须10
PageNum字符串必须1
EndTime字符串可选

客户端请求示例

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

HTTP通用示例 
{
    "err_code": 0,
    "err_msg": "",
    "total": 22,
    "items": [
        {
            "id": 22,
            "SN": "ABC123456",
            "DetectionTime": "2022-12-29 14:33:33",
            "DetectionData": "38.88dB"
        },
        {
            "id": 21,
            "SN": null,
            "DetectionTime": null,
            "DetectionData": null
        },
        {
            "id": 20,
            "SN": "ABCEFG123475",
            "DetectionTime": "2022-12-29 14:29:50",
            "DetectionData": "39.19"
        },
        {
            "id": 19,
            "SN": "ABCEFG123474",
            "DetectionTime": "2022-12-29 14:29:49",
            "DetectionData": "39.18"
        },
        {
            "id": 18,
            "SN": "ABCEFG123473",
            "DetectionTime": "2022-12-29 14:29:48",
            "DetectionData": "39.17"
        },
        {
            "id": 17,
            "SN": "ABCEFG123472",
            "DetectionTime": "2022-12-29 14:29:47",
            "DetectionData": "39.16"
        },
        {
            "id": 16,
            "SN": "ABCEFG123471",
            "DetectionTime": "2022-12-29 14:29:46",
            "DetectionData": "39.15"
        },
        {
            "id": 15,
            "SN": "ABCEFG123470",
            "DetectionTime": "2022-12-29 14:29:45",
            "DetectionData": "39.14"
        },
        {
            "id": 14,
            "SN": "ABCEFG123469",
            "DetectionTime": "2022-12-29 14:29:44",
            "DetectionData": "39.13"
        },
        {
            "id": 13,
            "SN": "ABCEFG123468",
            "DetectionTime": "2022-12-29 14:29:43",
            "DetectionData": "39.12"
        },
        {
            "id": 12,
            "SN": "ABCEFG123467",
            "DetectionTime": "2022-12-29 14:29:42",
            "DetectionData": "39.11"
        },
        {
            "id": 11,
            "SN": "ABCEFG123466",
            "DetectionTime": "2022-12-29 14:29:41",
            "DetectionData": "36.99"
        },
        {
            "id": 10,
            "SN": "ABCEFG123465",
            "DetectionTime": "2022-12-29 14:29:40",
            "DetectionData": "36.98"
        },
        {
            "id": 9,
            "SN": "ABCEFG123464",
            "DetectionTime": "2022-12-29 14:29:39",
            "DetectionData": "36.97"
        },
        {
            "id": 8,
            "SN": "ABCEFG123463",
            "DetectionTime": "2022-12-29 14:29:38",
            "DetectionData": "36.96"
        },
        {
            "id": 7,
            "SN": "ABCEFG123462",
            "DetectionTime": "2022-12-29 14:29:37",
            "DetectionData": "36.95"
        },
        {
            "id": 6,
            "SN": "ABCEFG123461",
            "DetectionTime": "2022-12-29 14:29:36",
            "DetectionData": "36.94"
        },
        {
            "id": 5,
            "SN": "ABCEFG123460",
            "DetectionTime": "2022-12-29 14:29:35",
            "DetectionData": "36.93"
        },
        {
            "id": 4,
            "SN": "ABCEFG123459",
            "DetectionTime": "2022-12-29 14:29:34",
            "DetectionData": "36.92"
        },
        {
            "id": 3,
            "SN": "ABCEFG123458",
            "DetectionTime": "2022-12-29 14:29:33",
            "DetectionData": "36.91"
        },
        {
            "id": 2,
            "SN": "ABCEFG123457",
            "DetectionTime": "2022-12-29 14:29:32",
            "DetectionData": "36.90"
        },
        {
            "id": 1,
            "SN": "ABCEFG123456",
            "DetectionTime": "2022-12-29 14:29:31",
            "DetectionData": "36.89"
        }
    ]
}

接口返回及数据结构

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

用户登陆 v1.1

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/SGlimmer8087_MyApi/AUserLogin

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.SGlimmer8087_MyApi.AUserLogin

接口描述： 用户登陆

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
user_id字符串必须
user_password字符串必须

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

获取皇田噪声检测数据列表 v1.2

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/SGlimmer8087_MyApi/AListHtnoisedetection

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.SGlimmer8087_MyApi.AListHtnoisedetection

接口描述： 获取最近检测数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。

客户端请求示例

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

HTTP通用示例 
{
    "err_code": 0,
    "err_msg": "",
    "total": 22,
    "items": [
        {
            "id": 22,
            "SN": "ABC123456",
            "DetectionTime": "2022-12-29 14:33:33",
            "DetectionData": "38.88dB"
        },
        {
            "id": 21,
            "SN": null,
            "DetectionTime": null,
            "DetectionData": null
        },
        {
            "id": 20,
            "SN": "ABCEFG123475",
            "DetectionTime": "2022-12-29 14:29:50",
            "DetectionData": "39.19"
        },
        {
            "id": 19,
            "SN": "ABCEFG123474",
            "DetectionTime": "2022-12-29 14:29:49",
            "DetectionData": "39.18"
        },
        {
            "id": 18,
            "SN": "ABCEFG123473",
            "DetectionTime": "2022-12-29 14:29:48",
            "DetectionData": "39.17"
        },
        {
            "id": 17,
            "SN": "ABCEFG123472",
            "DetectionTime": "2022-12-29 14:29:47",
            "DetectionData": "39.16"
        },
        {
            "id": 16,
            "SN": "ABCEFG123471",
            "DetectionTime": "2022-12-29 14:29:46",
            "DetectionData": "39.15"
        },
        {
            "id": 15,
            "SN": "ABCEFG123470",
            "DetectionTime": "2022-12-29 14:29:45",
            "DetectionData": "39.14"
        },
        {
            "id": 14,
            "SN": "ABCEFG123469",
            "DetectionTime": "2022-12-29 14:29:44",
            "DetectionData": "39.13"
        },
        {
            "id": 13,
            "SN": "ABCEFG123468",
            "DetectionTime": "2022-12-29 14:29:43",
            "DetectionData": "39.12"
        },
        {
            "id": 12,
            "SN": "ABCEFG123467",
            "DetectionTime": "2022-12-29 14:29:42",
            "DetectionData": "39.11"
        },
        {
            "id": 11,
            "SN": "ABCEFG123466",
            "DetectionTime": "2022-12-29 14:29:41",
            "DetectionData": "36.99"
        },
        {
            "id": 10,
            "SN": "ABCEFG123465",
            "DetectionTime": "2022-12-29 14:29:40",
            "DetectionData": "36.98"
        },
        {
            "id": 9,
            "SN": "ABCEFG123464",
            "DetectionTime": "2022-12-29 14:29:39",
            "DetectionData": "36.97"
        },
        {
            "id": 8,
            "SN": "ABCEFG123463",
            "DetectionTime": "2022-12-29 14:29:38",
            "DetectionData": "36.96"
        },
        {
            "id": 7,
            "SN": "ABCEFG123462",
            "DetectionTime": "2022-12-29 14:29:37",
            "DetectionData": "36.95"
        },
        {
            "id": 6,
            "SN": "ABCEFG123461",
            "DetectionTime": "2022-12-29 14:29:36",
            "DetectionData": "36.94"
        },
        {
            "id": 5,
            "SN": "ABCEFG123460",
            "DetectionTime": "2022-12-29 14:29:35",
            "DetectionData": "36.93"
        },
        {
            "id": 4,
            "SN": "ABCEFG123459",
            "DetectionTime": "2022-12-29 14:29:34",
            "DetectionData": "36.92"
        },
        {
            "id": 3,
            "SN": "ABCEFG123458",
            "DetectionTime": "2022-12-29 14:29:33",
            "DetectionData": "36.91"
        },
        {
            "id": 2,
            "SN": "ABCEFG123457",
            "DetectionTime": "2022-12-29 14:29:32",
            "DetectionData": "36.90"
        },
        {
            "id": 1,
            "SN": "ABCEFG123456",
            "DetectionTime": "2022-12-29 14:29:31",
            "DetectionData": "36.89"
        }
    ]
}

接口返回及数据结构

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

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

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