https://github.com/rinvex/authy
Rinvex Authy is a simple wrapper for @Authy TOTP API, the best rated Two-Factor Authentication service for consumers, simplest 2fa Rest API for developers and a strong authentication platform for the enterprise.
https://github.com/rinvex/authy
authy phone php sms twilio two-factor-authentication
Last synced: 5 months ago
JSON representation
Rinvex Authy is a simple wrapper for @Authy TOTP API, the best rated Two-Factor Authentication service for consumers, simplest 2fa Rest API for developers and a strong authentication platform for the enterprise.
- Host: GitHub
- URL: https://github.com/rinvex/authy
- Owner: rinvex
- License: mit
- Created: 2016-11-14T19:43:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-03T13:29:38.000Z (over 2 years ago)
- Last Synced: 2024-12-08T20:11:17.723Z (about 1 year ago)
- Topics: authy, phone, php, sms, twilio, two-factor-authentication
- Language: PHP
- Size: 200 KB
- Stars: 36
- Watchers: 7
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rinvex Authy
**Rinvex Authy** is a simple wrapper for Authy TOTP API, the best rated Two-Factor Authentication service for consumers, simplest 2fa Rest API for developers and a strong authentication platform for the enterprise.
[](https://packagist.org/packages/rinvex/authy)
[](https://scrutinizer-ci.com/g/rinvex/authy/)
[](https://travis-ci.org/rinvex/authy)
[](https://styleci.io/repos/73740838)
[](https://github.com/rinvex/authy/blob/develop/LICENSE)
## Table Of Contents
- [Usage](#usage)
- [Installation](#installation)
- [Upgrade](#upgrade)
- [Changelog](#changelog)
- [Support](#support)
- [Contributing & Protocols](#contributing--protocols)
- [Security Vulnerabilities](#security-vulnerabilities)
- [About Rinvex](#about-rinvex)
- [Trademarks](#trademarks)
- [License](#license)
## Usage
Usage is pretty easy and straightforward:
### Prepare requirements
```php
$apiKey = 'AuthySecretKey';
$httpClient = new \GuzzleHttp\Client();
```
> **Note:** make sure to replace `AuthySecretKey` with your secret key from the installation steps.
### Authy App
Create a new Authy app instance and interact with it:
```php
$authyApp = new \Rinvex\Authy\App($httpClient, $apiKey);
$appStats = $authyApp->stats(); // Get app stats
$appDetails = $authyApp->details(); // Get app details
```
### Authy User
Create a new Authy user instance and interact with it:
```php
$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 Token
Create a new Authy token instance and interact with it:
```php
$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
```
### Intuitive Responses
Work Intuitively with Authy responses:
```php
$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
```
> **Note:** All authy requests return authy response, with a unified interface for your convenience, so you can interact with all responses the same way as above.
## Installation
1. Install the package via composer:
```shell
composer require rinvex/authy
```
2. If you haven't already: Register an [Authy](https://www.authy.com) account -> Sign in -> Access [dashboard](https://dashboard.authy.com) -> Create new application -> Copy your API Secret key
3. Done! You can refer to [Usage](#usage) again.
## Upgrade
- **Upgrading To `v2.x` From `v1.x`**
API implementation is 100% backward compatible, but sandbox API has been dropped since it's officially deprecated. Also note that PHP7 is now required.
## Changelog
Refer to the [Changelog](CHANGELOG.md) for a full history of the project.
## Support
The following support channels are available at your fingertips:
- [Chat on Slack](https://bit.ly/rinvex-slack)
- [Help on Email](mailto:help@rinvex.com)
- [Follow on Twitter](https://twitter.com/rinvex)
## Contributing & Protocols
Thank you for considering contributing to this project! The contribution guide can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
Bug reports, feature requests, and pull requests are very welcome.
- [Versioning](CONTRIBUTING.md#versioning)
- [Pull Requests](CONTRIBUTING.md#pull-requests)
- [Coding Standards](CONTRIBUTING.md#coding-standards)
- [Feature Requests](CONTRIBUTING.md#feature-requests)
- [Git Flow](CONTRIBUTING.md#git-flow)
## Security Vulnerabilities
If you discover a security vulnerability within this project, please send an e-mail to [help@rinvex.com](help@rinvex.com). All security vulnerabilities will be promptly addressed.
## About Rinvex
Rinvex is a software solutions startup, specialized in integrated enterprise solutions for SMEs established in Alexandria, Egypt since June 2016. We believe that our drive The Value, The Reach, and The Impact is what differentiates us and unleash the endless possibilities of our philosophy through the power of software. We like to call it Innovation At The Speed Of Life. That’s how we do our share of advancing humanity.
## Trademarks
- [Authy™](https://www.authy.com) is a trademark of [Twilio Inc.](https://www.twilio.com)
## License
This software is released under [The MIT License (MIT)](LICENSE).
(c) 2016-2022 Rinvex LLC, Some rights reserved.