注意:
自2023年07月18日起,启用新验证码 JS 地址,请您务必在2023年08月21日前,切换到新验证码 JS 地址,详情请参见 验证码 JS 地址变更指引。
自2023年08月21日起,将原服务端票据校验量(服务端发起票据校验的次数)计费方式修改为客户端验证量计费方式,详情请参见验证码功能升级及计费方式变更完成说明。
验证码调用时序图
Web/App 客户端
Web/App 客户端区分两类验证方式,普通验证方式(滑动拼图、语义点选等),无感验证方式。不同认证方式配置安全配置,实现灵活的验证码验证方式。
普通验证方式调用时序图如下:
无感验证方式调用时序图如下:
感知模式调用时序图如下:
微信小程序客户端
微信小程序客户端调用时序图如下:
快速接入
步骤1:新建验证,获取验证码密钥
1. 登录 验证码控制台,左侧导航栏选择图形验证 > 验证管理,进入验证管理页面。
2. 单击新建验证,根据业务场景需求,设置验证名称、客户端类型、验证方式等参数。
3. 单击确定,完成新建验证,即可在验证列表中查看验证码密钥( CaptchaAppId 及 AppSecretKey)。
步骤2:客户端接入验证码,展示验证页面
客户端需接入验证码,展示验证页面。不同客户端接入验证码的方式不同:
微信小程序客户端:需引入小程序插件接入,详情参见 微信小程序接入。
注意
不同客户端需使用对应客户端的 CaptchaAppId,不可混用,否则会导致验证数据统计异常。
Web/App 客户端接入时,需动态加载TCaptcha.js。如通过其他手段规避动态加载,会导致验证码无法正常更新,对抗能力无法保证,甚至引起误拦截。
步骤3:服务端接入验证码,调用票据校验 API 进行二次校验
服务端需调用票据校验 API,对客户端验证结果进行二次校验。 不同客户端调用的票据校验接口不同:
Web/App客户端:需调用 DescribeCaptchaResult 接口进行票据校验,详情参见 接入票据校验(Web 及 App)。
微信小程序客户端:需调用 DescribeCaptchaMiniResult 接口进行票据校验,详情参见 接入票据校验(微信小程序)。
注意
未接入票据校验,会导致黑产轻易伪造验证结果,失去验证码人机对抗效果。
不同客户端需调用对应客户端的票据校验 API,不可混用,否则会导致接口报错。
更多功能
验证码控制台还支持以下功能:
数据统计:查看请求量、验证通过量、验证拦截量、票据校验量等统计数据。
验证配置:验证码安全、外观等相关配置调整。
IP 白名单:针对 IP 进行白名单配置,减少风控触发逻辑。