alandownie / node-xero

Node.js wrapper for the Xero API

node-xero

An ES2015/JS SDK for Xero. Webpack, Browserify & Node.js friendly.

Features

• Super lightweight
• Browserify, Webpack & Node friendly
• Support for multiple environments
• Connectivity for all three API types
• Promises/A+ (async/await! callback free!)
• Simple API

Notes

A Xero app can be of three types:

Public applications authenticate with a 3-way OAuth handshake, therefore this would generally be for a web application, where end in-browser interaction is necessary to authorize a connection to your Xero app.

Private applications authenticate with a 2-way OAuth handshake, therefore this would generally be for a server side or CLI application where end user interaction is not required. Instead of providing a consumerSecret string, a valid RSA private key path should be provided and used to authenticate with its respective public key that was uploaded to your Xero application's organization.

Partner applications authenticate with ...

Creating certs for Private applications

$ openssl genrsa -out privatekey.pem 1024

$ openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825

$ openssl pkcs12 -export -out public_privatekey.pfx -inkey privatekey.pem -in publickey.cer

You can then confirm the validity of your private key

$ openssl rsa -text -in privatekey.pem

Usage

Create an instance

const config = {
  appType: 'private', // or `public`, or `partner`
  consumerKey: 'FXN4S4HPXBYQKZNCTGZX2SXWB0FXK2',
  consumerSecret: 'ssl/privatekey.pem', // or an actual `consumerSecret` if `appType` is `public`
}
const xero = Xero(config)

A-la-carte endpoint requests

const accts = xero.fetch('Accounts')
.then(resp => {
  console.log(resp)
})
.catch(resp => {
  console.log(resp)
})

const orgs = await xero.fetch('Organisations')

CRUD helper methods

xero.api.accounting.create({...}) (PUT)
xero.api.accounting.read({...})   (GET)
xero.api.accounting.update({...}) (POST)
xero.api.accounting.delete({...}) (DELETE)