JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 35740
  • Score
    100M100P100Q140183F
  • License MIT

Authy.com API lib for node.js

Package Exports

  • authy

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (authy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-authy Dependency Status

Authy API Client for node.js

Usage

Installation

npm install authy

When in doubt check out the official Authy API docs

Require all the things

var authy = require('authy')('APIKEY');

If you want to use the sandbox for testing require this way.

var authy = require('authy')('SANDBOX_APIKEY', 'http://sandbox-api.authy.com');

Register New User

register_user(email, cellphone, [country_code], callback);

authy.register_user('baldwin@andyet.net', '509-555-1212', function (err, res) {
    // res = {user: {id: 1337}} where 1337 = ID given to use, store this someplace
});

Verify Token

verify(id, token, [force], callback);

authy.verify('1337', '0000000', function (err, res) {

});

Request SMS

request_sms(id, [force], callback);

authy.request_sms('1337', function (err, res) {

});

Request Call (Email support@authy.com to enable this feature)

request_call(id, [force], callback);

authy.request_call('1337', function (err, res) {

});

Delete Registered User

delete_user(id, callback);

authy.delete_user('1337', function (err, res) {

});

Additional Contributors

Daniel Barnes