README

Rinvex Authy 是 Authy TOTP API 的简单封装，是消费者评分最高的两步验证服务，为开发者提供最简单的 2fa Rest API，同时也是企业级强认证平台。

使用方法

使用非常简单直接

准备需求

$apiKey = 'AuthySecretKey';
$httpClient = new \GuzzleHttp\Client();

注意：请确保将 AuthySecretKey 替换为安装步骤中的密钥。

Authy 应用

创建新的 Authy 应用实例并与它交互

$authyApp = new \Rinvex\Authy\App($httpClient, $apiKey);

$appStats = $authyApp->stats(); // Get app stats
$appDetails = $authyApp->details(); // Get app details

Authy 用户

创建新的 Authy 用户实例并与它交互

$authyUser = new \Rinvex\Authy\User($httpClient, $apiKey);

$user = $authyUser->register('user@domain.com', '317-338-9302', '54'); // Register user
$userActivity = $authyUser->registerActivity($user->get('user')['id'], 'cookie_login', 'Test Data'); // Register user activity
$userStatus = $authyUser->status($user->get('user')['id']); // Get user status
$userDeleted = $authyUser->delete($user->get('user')['id']); // Delete user

Authy 令牌

创建新的 Authy 令牌实例并与它交互

$authyToken = new \Rinvex\Authy\Token($httpClient, $apiKey);

$smsTokenSent = $authyToken->send($user->get('user')['id'], 'sms'); // Send SMS token
$callTokenStarted = $authyToken->send($user->get('user')['id'], 'call'); // Start automated call
$tokenVerified = $authyToken->verify(54321, $user->get('user')['id']); // Verify token

直观的响应

与 Authy 响应直观地工作

$body = $tokenVerified->body(); // Get all response body
$code = $tokenVerified->statusCode(); // Get response status code
$succeed = $tokenVerified->succeed(); // Check whether respose is a success
$failed = $tokenVerified->failed(); // Check whether respose is a failure
$message = $tokenVerified->message(); // Get response message
$item = $tokenVerified->get('item'); // Get response body item
$errors = $tokenVerified->errors(); // Get response errors

注意：所有 authy 请求都会返回 authy 响应，提供了一个统一的界面以便您方便地交互，因此您可以像上面那样与所有响应进行交互。

安装

通过 composer 安装包
```
composer require rinvex/authy
```
如果您还没有：注册一个 Authy 账户 -> 登录 -> 访问仪表板 -> 创建新应用 -> 复制您的 API 密钥
完成！您现在可以再次参考使用方法。

升级

从 v1.x 升级到 v2.x

API 实现是 100% 向后兼容的，但沙盒 API 已被弃用，因为已经正式弃用。另外请注意，现在需要 PHP7。

变更日志

请参阅变更日志了解项目的完整历史。

支持

以下支持渠道随时可供您使用

贡献 & 协议

感谢您考虑为这个项目做出贡献！贡献指南可以在 CONTRIBUTING.md 中找到。

欢迎提交错误报告、功能请求和拉取请求。

安全漏洞

如果您在这个项目中发现安全漏洞，请通过电子邮件发送至 help@rinvex.com。所有安全漏洞都将得到及时处理。

关于 Rinvex

Rinvex 是一家专注于为中小企业提供集成企业解决方案的软件解决方案初创公司，自 2016 年 6 月在埃及亚历山大成立以来。我们相信，我们的驱动力——价值、触达和影响力是我们与众不同的地方，并通过软件的力量释放我们哲学的无限可能性。我们喜欢称之为“生活速度的创新”。这就是我们如何为推动人类进步贡献我们的一份力量。

商标

Authy™ 是 Twilio Inc. 的商标。

许可证

本软件遵循 MIT 许可证 (MIT) 发布。

rinvex / authy

维护者

详细信息