# 生物认证秘钥签名验证
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:verifySignature
该接口用于SOTER 生物认证秘钥签名验证。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/soter/verify_signature?access_token=ACCESS_TOKEN
# 云调用
调用方法:soter.verifySignature
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 用户 openid |
| json_string | string | 是 | 通过 wx.startSoterAuthentication 成功回调获得的 resultJSON 字段 |
| json_signature | string | 是 | 通过 wx.startSoterAuthentication 成功回调获得的 resultJSONSignature 字段 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| is_ok | boolean | 验证结果 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
# 5.1 HTTPS调用
请求示例
{
"openid": "$openid",
"json_string": "$resultJSON",
"json_signature": "$resultJSONSignature"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"is_ok": true
}
# 5.2 云函数调用
请求示例
const cloud = require('wx-server-sdk') cloud.init({ env: cloud.DYNAMIC_CURRENT_ENV, }) exports.main = async (event, context) => { try { const result = await cloud.openapi.soter.verifySignature({ "openid": '$openid', "jsonString": '$resultJSON', "jsonSignature": '$resultJSONSignature' }) return result } catch (err) { return err } }
返回示例
{
"errcode": 0,
"errmsg": "ok",
"is_ok": true
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 小程序 | 公众号 | 服务号 |
|---|---|---|
| ✔ | ✔ | ✔ |
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;