node-golfnow

#Golf Now API

Promise based API library that exposes an abstraction over the GolfNow Affiliate API. Doing this cause I didn't like the implementation of another solution.

Installation

$ npm install --save node-golfnow

Usage

import golfnow from 'node-golfnow';
//const golfnow = require('golfnow'); // for non import env

const api = golfnow({
	client_id: 'insert client id here',
	client_secret: 'supper secret client key right here',
	channel_id: 19189 //optional || default is 1
});

api.root()
	.then(res => console.log(res.data));
	.catch(err => console.log(err.response.data));

API

At it's core node-golfnow uses axios. It currently exposes abstactions around the [root, channels, course, courses, rateTags, invoices] resouces of the API, however any missing or new enpoint can be implemented via the the extension get and post methods

Root

api.root()
	.then(res => console.log(res.data));
	.catch(err => console.log(err.response.data));

Setting API context

Important: you must use the .setChannel([chanel_id:required]) method to establish the context in which your API runs in. I know...I know...this is dictated by the API, but hopefully in the near future this can be abstracted that out :)

api.setChannel(12345);

Channels

If a channel is not passed, then it will return a list of channels that you have access to.

api.channels([channel_id:optional])
	.then(res => {
		api.setChannel(/*le channel id*/)
		console.log(res.data)
	});
	.catch(err => console.log(err.response.data));

Custom endpoints

The sdk exposes the get and post methods for customized integration with the GolfNow Affiliate API

const channel = api.getChannel();

api.get(`/channels/${channel}/customers/${customer-email}/reservations/${reservation-id}`)
	.then(res => console.log(res.data));
	.catch(err => console.log(err.response.data));


app.post(url, payload)
	.then(res => console.log(res.data));
	.catch(err => console.log(err.response.data));

Tests

$ npm test

Contributors

Ashley Narcisse [e-mail]