jincor/verify-php-client

一个封装与 Jincor Verify 服务交互的 PHP 库

dev-master 2017-11-30 13:21 UTC

This package is not auto-updated.

Last update: 2024-09-19 19:53:12 UTC


README

这是一个封装与 Jincor Verify 交互的客户端库。通过它,您可以

  1. 启动 email、google_auth 方法的验证流程。
  2. 验证代码。
  3. 无效化代码。

用法

初始化 Verify 客户端

要使用 HTTP 协议进行交互,请使用 Guzzle。必要的头信息包括 Accept: application/vnd.jincor+json; version=1Content-Type: application/jsonAuthorization: Bearer JWT_TOKEN

$verifyClient = new VerifyClient(new Client([
    'base_uri' => 'verify:3000',
    'headers' => [
        'Accept'        => 'application/vnd.jincor+json; version=1',
        'Content-Type'  => 'application/json',
        'Authorization' => 'Bearer JWT_TOKEN',
    ]
]));

启动验证流程

$verificationDetails = $verifyClient->initiate(
    (new EmailVerification())
        ->setTemplate('{{{CODE}}}')
        ->setConsumer('test@test.com')
        ->setExpiredOn('01:00:00')
);

验证代码

$result = $verifyClient->validate(new EmailValidationData(
    new Uuid('d6b78279-db85-467e-b965-c938d043ffac'),
    '123456'
));
// true

无效化代码

$result = $verifyClient->invalidate(new GoogleAuthInvalidationData(
    new Uuid('d6b78279-db85-467e-b965-c938d043ffab')
));
// true

更多详细信息可以在测试中获得。

项目设置

  1. 克隆仓库
  2. cd /path/to/repo
  3. docker-compose build - 构建开发容器
  4. docker-compose up -d - 运行容器
  5. docker-compose exec workspace composer install

本地测试

要运行所有测试,请输入 docker-compose exec workspace ./vendor/bin/codecept run

鸣谢

许可证

MIT 许可证 (MIT)。更多信息请参阅 许可证文件