Skip to content

meltay/node-authy-helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Authy Verify API Helper For Node.JS

Zero Dependency

Build Status

Official Authy documentation

Installation

npm i authy-helper --save

Usage

Authy Create User

const  authy = require('authy-helper')('YOUR API KEY');

  

var  createSmsUserResult = await authy.createUser('test@test.com', '532999999', '90');
console.log(createSmsUserResult.user.id) // This is authyId of user

Authy Delete User

const  authy = require('authy-helper')('YOUR API KEY');
var  createSmsUserResult = await authy.delete(userAuthyId);

Send Verify Code via Sms

let force = true; // default value false.
let sendSmsResult = await authy.sendSmsVerifyCode(userAuthyId, force);

Verify Code

let  verifySmsCodeResult = await authy.verifySmsCode(userAuthyId, code);

Send Push Authentication Request

let  sendPushResultResult = await authy.sendPushAuthenticationRequest(
userAuthyId,

'This is test', // Push message title

{ // OPTIONAL

username: 'Meltay Berk',

location: 'Izmir'

},

{ // OPTIONAL

transaction_num: "TRAACCBB"

},

null, // Logo

120000  // Code expire time (second)

);

var  transactionId = sendPushResultResult.approval_request.uuid;

Check Push Authentication Request State

let  status = await authy.checkAuthenticationRequestStatus(uuid);
console.log(status.approval_request.status); // pending, aproved, expired or denied

Get App Details

let appDetails = await authy.getAppDetails();
console.log(appDetails);

Get User Status

let userStatus = await authy.getUserStatus(userAuthyId);
console.log(userStatus);

Test for Developer

npm test