前言
本验证码由开源项目改编后向各位开发者提供服务,因此,小周不对使用产生的后果负责,请悉知,如果您介意此项,请终止对接,您在小周的平台(包括下辖的所有网站)创建账号,默认您同意该服务条约。
创建账号
前往控制台创建账号(注意:当前控制台由于在升级-截至2024年4月15日后续控制台位置可能变更)
请等待跳转登录或授权页面,如果您没有账号,请创建账号,创建时权限ID请留空。
如果你是第一登录控制台,控制台将会为你创建APPID以及密钥等操作,需要你重新授权,如果你的登录信息没有过期,点击登录后,将会自动定向回到控制台。完成创建。
限制
普通账号(默认):免费公开的API已经默认开通。
具体限制请查看【配额】中的详细信息。
变更记录
2024年4月15日
1.修改免费版授权域名为:captcha.ywxmz.com(原为:20030320.xyz)
注意事项
1.此点击验证码暂不适用于微信、QQ等内置浏览器情况。
对接开发
1.获取[授权ID]APPID
当你成功登录控制台后,在数据详情,也就是主页上,你可以在最上一栏查看你的授权ID以及密钥等信息。
2.设置调用信息
点击左侧API列表,选择【点选验证码】,后你可以获取到你的调用域信息,【请求域】为你的调用地址,需要在你的<head>标签中写入你的配置信息。
在你的前端代码中,需要填写下面的代码在<head>标签中
<script>
function user_data(){
return {
//这里请填写后台分配给你的请求域(请求/检查验证域),填写错误可能导致业务无法正常进行
check_url: '请求域(请求/检查验证域)[请确保请求域是否正确(请求域结尾为/)]'
};
}
</script>
3.调用JS
JS文件强烈建议你在线调用,避免错过更新导致业务异常。
【JS调用地址】为您调用Javascript文件的链接,请确认上面一步已经完成,再紧接着在上方<script>标签后引入JS,其中appid请替换为你的APPID
<script src="https://api.txtx.xyz/v2/captcha/clicaptcha/v3-enjs.js?appid=**********"></script>
注意,此文件中包含了jQuery3.7.0,如果你需要使用jQuery无需再次引入。
如果你的部署因为引入jQuery无法使用,抱歉,你可能无法继续使用此验证码,因为此验证码依赖jQuery。
4.调用验证码
你需要在需要的地方引入此代码。
<input type="hidden" id="clicaptcha-submit-info" name="clicaptcha-submit-info">
5.唤起验证码
这里示例为button的方式唤出验证。
在适合的地方添加button
<button type="button" id="sub">登录</button>
6.后续逻辑代码
请将下方的<script>放在<body>的最后面
<script>
$(function(){
$('#sub').click(function(){
$('#clicaptcha-submit-info').clicaptcha({
src: user_data().check_url,
callback: function(){
//验证通过后的业务逻辑
//你可以在这里设计你的验证成功后的业务逻辑
}
});
});
});
</script>
7.其他
1).设置防盗链避免盗刷
在【控制台】-【API列表】-【点选验证码】中
你可以限制请求域,建议你设置为你的域名,例如:forhwx.cn,设置之后只能你的域名能够请求,防止因APPID泄露导致盗刷。
2).更换更快的JS源
默认的JS源部署在香港服务器上,由于地理原因导致加载可能缓慢,如果你需要切换到国内源,请与小周联系。
3).版本订阅
默认的免费版能够满足绝大部分个人建站者的需要,如果你的需求较高,且愿意继续使用小周的验证码,你可以通过捐赠的方式获取其他版本。
4).为什么要自己开发验证码
因为包括现在的阿某云、腾某云等的人机验证码,套餐过贵。