library php

authy/php

PHP client for Authy

, _(*1)

🚨🚨🚨, _(*2)

This library is no longer actively maintained. The Authy API has been replaced with the Twilio Verify API. Twilio will support the Authy API through November 1, 2022 for SMS/Voice. After this date, we’ll start to deprecate the service for SMS/Voice. Any requests sent to the API after May 1, 2023, will automatically receive an error. Push and TOTP will continue to be supported through July 2023., _(*3)

Learn more about migrating from Authy to Verify., _(*4)

Please visit the Twilio Docs for: * Verify + PHP (Laravel) quickstart * Twilio PHP helper library * Verify API reference, _(*5)

Please direct any questions to Twilio Support. Thank you!, _(*6)

🚨🚨🚨, _(*7)

PHP Client for Twilio Authy Two-Factor Authentication (2FA) API

Documentation for PHP usage of the Authy API lives in the official Twilio documentation., _(*8)

The Authy API supports multiple channels of 2FA: * One-time passwords via SMS and voice. * Soft token (TOTP via the Authy App) * Push authentication via the Authy App, _(*9)

If you only need SMS and Voice support for one-time passwords, we recommend using the Twilio Verify API instead. More on how to choose between Authy and Verify here., _(*10)

Authy Quickstart

For a full tutorial, check out the PHP/Laravel Authy Quickstarts in our docs: * PHP/Laravel Authy Quickstart, _(*11)

Authy PHP Installation

This library requires PHP 5.6+, _(*12)

Install with composer. The authy/php package is available on Packagist., _(*13)

Include in your composer.json as follows:, _(*14)

{
    "require": {
        "authy/php": "3.0.5"
    }
}

Usage

To use the Authy client, import AuthyApiClient and initialize it with your production API Key found in the Twilio Console:, _(*15)

$authy_api = new Authy\AuthyApi('#your_api_key');

, _(*16)

2FA Workflow

1. Create a user
2. Send a one-time password
3. Verify a one-time password

OR, _(*17)

1. Create a user
2. Send a push authentication
3. Check a push authentication status

Phone Verification

Phone verification now lives in the Twilio API and has PHP support through the official Twilio helper libraries., _(*18)

Legacy (V1) documentation here. Verify V1 is not recommended for new development. Please consider using Verify V2., _(*19)

Contributing

You can use docker to run tests and develop locally without the need to install the dependencies directly in your machine:, _(*20)

git clone git@github.com:authy/authy-php.git
cd authy-php
make docker-build # Creates the docker image
make docker-deps  # Install dependencies (in the `vendor` directory)
make docker-test  # Runs the tests

To contribute, make your changes in a branch and send a Pull Request to the twilio/authy-php repo., _(*21)

Copyright

Copyright (c) 2011-2020 Authy Inc. See LICENSE for further details., _(*22)