A php library for using the Authy API.
To use this client you just need to use Authy_Api and initialize it with your API KEY
$authy_api = new Authy_Api('#your_api_key');
Now that you have an Authy API object you can start sending requests.
Creating users is very easy, you need to pass an email, a cellphone and optionally a country code:
$user = $authy_api->register_user('[email protected]', '405-342-5699', 1); //email, cellphone, area_code
in this case 1 is the country code (USA). If no country code is specified, it defaults to USA.
You can easily see if the user was created by calling ok().
If request went right, you need to store the authy id in your database. Use user->id() to get this id in your database.
if($user->ok())
// store user->id() in your user database
if something goes wrong ok() returns false and you can see the errors using the following code
else
$user->errors();
it returns a dictionary explaining what went wrong with the request. Errors will be in plain English and can be passed back to the user.
To verify tokens you need the user id and the token. The token you get from the user through your login form.
$verification = $authy_api->verifyToken('authy-id', 'token-entered-by-the-user')
Once again you can use ok() to verify whether the token was valid or not.
if($verification->ok())
// the user is valid
To be able to use this method you need to have activated the SMS plugin for your Authy App.
To request a SMS token you only need the user id.
$sms = $authy_api->requestSms('authy-id');
As always, you can use ok() to verify if the token was sent.
This call will be ignored if the user is using the Authy Mobile App. If you still want to send
the SMS pass force=>true as an option
$sms = $authy_api->request_sms('authy-id', array("force" => true));
You can find the full API documentation in the official documentation page.