relateiq

0.0.7 • Public • Published

node-relateiq

Circle CI

This module makes it easier to communicate with the RelateIQ API in a asynchrounous way.

Install

  • You first want to install the package to your project.

      npm install relateiq --save
    

Example

var relateiq = require('relateiq');
relateiq.createAccount({
  name: "Abacus"
}, function(err, account) {
  console.log(err);
  console.log(account.id);
});

You can look at more examples in the tests.

License

MIT.

Notes

This is an ongoing project, not all endpoints are fully supported. This is used in conjunction with Abacus and is updated to the needs of that product. If you need an endpoint supported, submit a issue or make it yourself with a pull request.

If you decide to make an endpoint you will need to test your change locally with npm test. The key and secret provided may not work so you'll need to use your own test account to do so. All you need to do is create a .env file in the root of this project with the following lines.

RELATEIQ_KEY=
RELATEIQ_SECRET=

Readme

Keywords

none

Package Sidebar

Install

npm i relateiq

Weekly Downloads

0

Version

0.0.7

License

MIT

Last publish

Collaborators

  • sjlu