ryanmoorman / api-js-node

A JS Node client for Usabilla API

Node client for Usabilla API

The Usabilla API Client for Node.js provides access to the Usabilla database from Node.js applications.

The client has the following features:

• Getting the buttons / campaigns / widgets / forms as well as the feedback they contain.
• Querying over the feedback with different parameters.

Authentication

The client uses extensive authentication based on a request signing process. For more information, please see our developers guide

Getting started

Install node client through npm

$ npm install usabilla-api --save

Usage

An example that displays the number of buttons:

var Usabilla = require('usabilla-api');
var usabilla = new Usabilla('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY');

usabilla.websites.buttons.get().then((buttons) => {
    console.log('Number of buttons: ', buttons.length);
}).catch((reason) => {
    console.error(reason);
});

See the code in the example folder for more advanced ideas on how to use the client.

Contribute

Install the required packages

$ npm install

start the development environment

$ npm start

and run tests with

$ npm test

To keep tests running while developing

$ npm run test:watch

For linting

$ npm run lint

and to fix automatically any lint errors

$ npm run lint:fix

Support

The Usabilla Node.js Client API is maintained by Usabilla Development Team. Everyone is encouraged to file bug reports, feature requests, and pull requests through GitHub. This input is critical and will be carefully considered, but we can’t promise a specific resolution or time frame for any request. For more information please email our Support Team at [e-mail]