Rinvex Authy PHP Client

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.

Description

Rinvex Authy (https://github.com/rinvex/authy) is a PHP client, that works as a simple wrapper for Authy (https://www.authy.com) TOTP API (https://docs.authy.com/totp.html), the best rated Two-Factor Authentication service for consumers, simplest 2fa Rest API for developers and a strong authentication platform for the enterprise.

Today we at Rinvex (https://rinvex.com) have released this awesome package Rinvex Authy (https://github.com/rinvex/authy) on Github as an #opensource package for the whole #php community to facilitate and ease the integration of the amazing Two-Factor authentication service Authy into PHP applications, which utilizes the latest recommended dependencies such as [Guzzle](https://github.com/guzzle/guzzle), the extensible PHP HTTP client, and of course takes advantage of the [PSR-7: HTTP message interfaces](http://www.php-fig.org/psr/psr-7/). It’s good to note that this package doesn’t require any specific framework to work, so it works fine with any of them.

Feel free to use the package as you wish, please open a new Github issue for any issues you may encounter, raise your voice with suggestions, recommendations or even criticism, we like it 😍 It’s very helpful for us to drive our software being better and more reliable for usage.

One last thing, we’ve plans for adding support for Authy OneTouch API, for the installation and usage please refer to: https://github.com/rinvex/authy Thank you for your time, enjoy 😊

Code Quality Rank: L5

Programming language: PHP

License: MIT License

Tags: Security     Authentication And Authorization     TFA     Authentication     Message     Sms     Authy     Two Factor Authentication     TwoFactor     Phone     Token     Call     Verification     Rinvex     Register     Automated    

Latest version: v5.0.1

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.

Table Of Contents

• Usage
• Installation
• Upgrade
• Changelog
• Support
• Contributing & Protocols
• Security Vulnerabilities
• About Rinvex
• Trademarks
• License

Usage

Usage is pretty easy and straightforward:

Prepare requirements

$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:

$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:

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

$user = $authyUser->register('[email protected]', '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:

$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:

$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:

   composer require rinvex/authy
   

2. If you haven't already: Register an Authy account -> Sign in -> Access dashboard -> Create new application -> Copy your API Secret key

3. Done! You can refer to 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
• Help on Email
• Follow on Twitter

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 [[email protected]]([email protected]). 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™ is a trademark of Twilio Inc.

License

This software is released under [The MIT License (MIT)](LICENSE).

(c) 2016-2020 Rinvex LLC, Some rights reserved.