Node.js client library for using Hiveage APIs. Supports authorization and authentication to the Hiveage API using basic authentication.
Hiveage Node.js SDK requires the following to run:
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
$ npm install hiveage
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);
});
Network
- createConnection(data)
- retriveConnection(hash)
- updateConnection(hash, data)
- listAllConnections(params)
- deleteConnection(hash)
- invoiceActivities(hash, params)
- estimateActivities(hash, params)
- recurringInvoice(hash, params)
Contacts
- createContact(hash, data)
- retriveContact(hash, id)
- updateContact(hash, id, data)
- listAllContacts(hash, params)
- deleteContact(hash, id)
Invoice
- createInvoice(data)
- retriveInvoice(hash)
- updateInvoice(hash, data)
- listAllInvoices(params)
- sendInvoice(hash, data)
- sendReminder(hash, data)
- deleteInvoice(hash)
Estimates
- createEstimate(data)
- retriveEstimate(hash)
- updateEstimate(hash, data)
- listAllEstimates(params)
- sendEstimates(hash, data)
- deleteEstimate(hash)
Payment
- createPayment(hash, data)
- retrivePayment(hash, id)
- updatePayment(hash, id, data)
- listAllPayments(hash, params)
- deletePayment(hash, id)
Expense
- createExpense(data)
- retriveExpense(params)
- updateExpense(id,data)
- listAllExpenses(id)
- deleteExpense(id)
EntryExpense
- createEntryExpense(data)
- retriveEntryExpense(id)
- updateEntryExpense(id,data)
- listAllEntryExpense(data)
- deleteEntryExpense(id)
Trip
EntryMileage
- createEntryMileage(data)
- retriveEntryMileage(id)
- updateEntryMileage(id, data)
- listAllEntryMileage(params)
- deleteEntryMileage(id)
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" }
- should be a JSON object
Please fork the repository and create a pull request.
- Axios - client-side HTTP request library.
Hiveage node api client is licensed under the MIT license.
Copyright © 2020, Hiveage Inc.