Hiveage NPM | npm.io

Hiveage Node.js Client

Node.js client library for using Hiveage APIs. Supports authorization and authentication to the Hiveage API using basic authentication.

Requirements

Hiveage Node.js SDK requires the following to run:

Node.js 0.10+
npm (normally comes with Node.js)

Features

Allows connecting to the Hiveage API and geting results as JSON Objects. The client has the following features:

Transparent HTTPS connection to the Hiveage API
Allows simple HTTP basic authentication
Allows most common HTTP operations: GET, POST, PUT, DELETE, PATCH

Installation

$ npm install hiveage

Usage

First we need to create a HiveageAPI Object:

//importing Hiveage Package
const Hiveage = require("hiveage");

// Create Hiveage object using domain, API key
const HiveageAPI = new Hiveage("<< DOMAIN >>", "<< API KEY >>");
// Example : new Hiveage('john','xyzabcsded')

Thereafter, we can access the available methods of the HiveageAPI object:

// Creating new connection
HiveageAPI.createConnection(data)
  .then((response) => {
    console.log(response);
  })
  .catch((err) => {
    console.log(err);
  });

Methods

List of available methods

Network

Contacts

Invoice

Estimates

Payment

Expense

EntryExpense

Trip

EntryMileage

Task

Item

Notes :

hash : must field
id : must field
data : must field
- should be a JSON object
params : optional field
- should be a JSON object
  - Example :-
```
params = { "per_page":20, "page":1, "order":"desc" }
```