Download the PHP package cann/laravel-vcode without Composer
On this page you can find all versions of the php package cann/laravel-vcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package laravel-vcode
laravel-vcode
便捷的验证码发送工具,目前支持基于[easysms]https://github.com/overtrue/easy-sms 的短信验证码
安装
发布资源
数据库迁移
参数配置
config/easysms.php
: 短信服务商配置
config/vcode.php
: 验证码相关配置
使用
定义环境变量
修改 .env
加入相关配置(以腾讯云短信通道为例):
发送验证码
该工具提供了统一的接口进行验证码发送:
请求
POST
:{host}/{prefix}/vcode
请求参数
字段 | 必填 | 类型 | 详细描述 |
---|---|---|---|
channel | 否 | STRING | 验证码发送渠道 sms : 短信验证码 (默认) email : 邮箱验证码 (暂不支持) |
scene | 是 | STRING | 发送场景 config/vcode.channels.{channel}.scenes 中定义 注:不同场景短信冷却时间不共享,验证码不通用 |
mobile | 是 | STRING | 发送目标,字段名可在 config/vcode.channels.{channel}.field 修改 |
captcha_key | 否 | STRING | 图形验证码 Key 注:当触发图形验证码时,该值必填 |
captcha_code | 否 | STRING | 图形验证码 注:当触发图形验证码时,该值必填 |
响应参数
字段 | 类型 | 详细描述 |
---|---|---|
code | INT | 响应码,可在 config/vcode.responses 修改 |
message | STRING | 响应消息,可在 config/vcode.responses 修改 |
data | ARRAY | 响应数据 |
响应成功样例
or
or
验证码校验
- 使用 Validator 验证,可在
vcode
参数上加上verify_code
验证器进行验证,verify_vcode
会自动读取请求中的channel
scene
mobile
vcode
参数进行校验 - 使用
verify_vcode(string $scene, string $mobile, string $vcode, string $channel)
方法进行校验
All versions of laravel-vcode with dependencies
PHP Build Version
Package Version
Requires
overtrue/easy-sms Version
^1.1
mews/captcha Version ^3.0
tencentcloud/tencentcloud-sdk-php Version dev-master
mews/captcha Version ^3.0
tencentcloud/tencentcloud-sdk-php Version dev-master
The package cann/laravel-vcode contains the following files
Loading the files please wait ....