rage4service

Promise-based communication with Rage4 API

rage4service is designed to be the simplest way to make calls to the API of Rage4 Networks.

Installation

The library is available on npm. Install the module with:

npm install rage4service

Usage

Create a new rage4service instance:

Rage4service = require('rage4service');

var r4s = new Rage4service("username", "password");

Credentials

The Rage4 API use your email adress as username and your API key as password. You can instantiate the Rage4service class without any credentials, in that case the environment variables RAGE4_USERNAME and RAGE4_PASSWORD are used.

Methods

All methods in the Rage4service class return promises. For more information on the various API endpoints (the corresponding method names are the same), see the API Documentation.

An example:

r4s.getdomains().then(function(arrayOfAllDomains) {
    console.log(arrayOfAllDomains);
});

All methods, return values and parameters are documented in full jsDoc comments.

Issues

Feel free to open a github issue if you experience something odd.

License

MIT