README

介绍 🖖

这是一个用于生成和验证一次性密码(OTP)的简单包。

通过composer安装

composer require iroid/laravel-otp

运行迁移

php artisan migrate

注意
响应以对象的形式返回。您可以使用箭头操作符 (->) 访问其属性

<?php

use Iroid\Otp\Otp;

(new Otp)->(string $identifier, string $type, int $length = 4, int $validity = 10);

<?php

use Iroid\Otp\Otp;

(new Otp)->generate('michael@okoh.co.uk', 'numeric', 6, 15);

这将生成一个有效期为15分钟的六位OTP，成功响应将是

{
  "status": true,
  "token": "282581",
  "message": "OTP generated"
}

<?php

use Iroid\Otp\Otp;

(new Otp)->validate(string $identifier, string $token)

<?php

use Iroid\Otp\Otp;

(new Otp)->validate('michael@okoh.co.uk', '282581');

成功

{
  "status": true,
  "message": "OTP is valid"
}

不存在

{
  "status": false,
  "message": "OTP does not exist"
}

无效*

{
  "status": false,
  "message": "OTP is not valid"
}

过期

{
  "status": false,
  "message": "OTP Expired"
}

您可以通过运行以下artisan命令来删除过期的令牌

php artisan otp:clean

您还可以将此artisan命令添加到app/Console/Kernel.php中，以便在计划的时间内自动清理

<?php

protected function schedule(Schedule $schedule)
{
    $schedule->command('otp:clean')->daily();
}

有兴趣贡献或修改请与我联系电子邮件。