NodeJS API implementation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib
tests/options
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

iMoneza NodeJS API

Version Build Status Coverage Status

A NodeJS library to integrate iMoneza into your application.

Using your http://imoneza.com account, you can interact with all parts of the API using this library. This library was tested and is supported on NodeJS 5.* - but may be compatible with older versions.

Installation

This library can be installed using npm.

npm install imoneza-api

Basic Usage

There are a number of ways to interact with the API. But, the way of performing each task is relatively the same. For this example, let's get the Property information from iMoneza.

var requestCallback = function(err, data) {
    if (err) {
        console.log("There was an error.");
        console.error(err);
    }
    else {
        console.log("It was successful.");
        console.info(data);
    }
};

var bunyan = require('bunyan');
var log = bunyan.createLogger({name: "iMoneza"});

var iMoneza = require('imoneza-api');

var getProperty = new iMoneza.options.manage.getProperty();
var connection = new iMoneza.connection(manageApiKey, manageApiSecret, accessApiKey, accessApiSecret, log);
connection.request(getProperty, requestCallback);

Documentation

Introduction
The Connection Object
Options Objects
Return Data: Main API documentation

About

Requirements

  • NodeJS 5+ (Only tested on 5, may work with older versions but not supported.)
  • iMoneza publisher account

Bugs, Feature Requests and Testing

The features of this project are handled internally by iMoneza. However, we do encourage you to visit the issues section here on GitHub if you have any suggestions, requests, or find a bug.

Author

iMoneza, LLC

Contributors

Aaron Saray

License

This library is licensed under the LGPLv3 License - see the LICENSE file for details