happyphper/tcaptcha

TCaptcha

v1 2022-07-15 19:06 UTC

Requires

• php: ^7.4 || ^8.0
• ext-curl: *
• ext-json: *
• tencentcloud/tencentcloud-sdk-php: ^3.0

MIT

• Baron

README

TencentCloud Captcha for Laravel Laravel版本的腾讯云验证码组件

Quick Start 快速开始

1. Install 安装

composer require happyphper/tcaptcha

1. Config 配置

php artisan vendor:publish

1. Env 环境变量

TENCENT_SECRET_ID=
TENCENT_SECRET_KEY=
TENCENT_CAPTCHA_APP_ID=
TENCENT_CAPTCHA_SECRET_KEY=
TENCENT_CAPTCHA_REGION=ap-beijing

1. Use 使用

<?php

namespace App\Http\Controllers;

use Happyphper\TCaptcha\TCaptchaFacade;
use Happyphper\TCaptcha\Requests\Params;

class TestController extends Controller
{
    public function __invoke()
    {
        try {
            $params = Params::fromArray([
                'CaptchaType' => 9,
                'Ticket'      => "t03Luf5ZBWSMx9ukgVy06PI_2iiO_o4MCSZhLERRya4WL46L68ulKme-4j_wJuzr6gbMP2ez4VvNxgZ6oAKFv5dySH7GxpptcZU88wIW3vG9mIOCn7LGbBJuw**",
                'UserIp'      => request()->ip(),
                'Randstr'     => "@ibL",
            ]);

            [$ok, $response] = TCaptchaFacade::Validate($params);

//             true
            info("ok", compact('ok'));

//             {"CaptchaCode":1,"CaptchaMsg":"OK","EvilLevel":0,"GetCaptchaTime":0,"RequestId":"d42a0113-b51c-4ff5-bfd9-cca215d3dcc4"}
//             {"CaptchaCode":8,"CaptchaMsg":"ticket expired 详情请参考：腾讯云-天御验证码-产品文档，搜索关键字“DescribeCaptchaResult”，查看输出参数中CaptchaCode字段的具体描述","EvilLevel":0,"GetCaptchaTime":1657889311,"RequestId":"5f53d27a-7283-4d21-af49-8e72dfcfe9fd"} 
            info("response", $response);

        } catch (\Happyphper\TCaptcha\Exceptions\ParamException $exception) {
            // Miss Parameters 参数缺失
            info("ParamException", $exception);
        } catch (\Happyphper\TCaptcha\Exceptions\HttpException $exception) {
            // TencentCloud Server Error
            info("HttpException", $exception);
        }

        return response()->json(['message' => 'ok']);
    }
}

Params Description 参数说明

    // 验证码类型，固定值为9，必填
    public int $captchaType = 9;
    // 票据，前端获得，滑动验证码成功后，必填
    public string $ticket = "";
    // 访问IP，必填
    public string $userIp = "";
    // 随机字符串，前端获得，滑动验证码成功后，必填
    public string $randStr = "";
    // 业务ID
    public int $businessId = 0;
    // 场景ID
    public int $sceneId = 0;
    // MacAddress mac地址
    public string $mac = "";
    // 手机设备号
    public string $imei = "";
    // 是否返回前端获取验证码时间，值为1
    public int $needGetCaptchaTime = 1;

Office Docs 官方文档

https://cloud.tencent.com/document/api/1110/36926

https://console.cloud.tencent.com/api/explorer?Product=captcha