requiresafe-sdk

An SDK for easily interacting with the RequireSafe API from JavaScript.

The SDK works both on the server and in a browser with browserify.

install

npm install requiresafe-sdk

example

var RequireSafe = require('requiresafe-sdk');
var package = require('./package.json');

var api = new RequireSafe({authToken: "XYZ"});
api.login().then(function () {
    api.get('/users/me').then(function (me) {
        console.log(me);
    });
});

API reference

Initializing new SDK([optionsObject])

You create an instance of the SDK by using new and optionally passing in an options object.

var SDK = require('requiresafe-sdk');

var api  = new SDK({authToken: 'SOME TOKEN'});

• options {Object} [optional]: An object with the following keys:
  • authToken {String}: an authentication token

Logging in

api.login('your@email.address', 'yourpassword').then(function () {
    // this method performs the login and caches your token in memory so that you don't need to pass
    // it manually later.
    api.get('/users/me').then(function (me) {
        // this call will be made with your cached authToken
    });
});

Making calls

This module is a thin wrapper around axios and supports all the same methods and features. The plain request method is found at api.request and all aliases are at api.[method]. The base part of the url is inserted for you, as well as your auth headers if they are available.

license

MIT