1.0.0 • Published 11 years ago

node-up v1.0.0

Weekly downloads
7
License
-
Repository
github
Last release
11 years ago

node-up

A node.js API wrapper for the undocumented Jawbone UP API.

Based on Eric Blue's most-excellent work, found here: http://eric-blue.com/projects/up-api/

TravisCI Build Status

##Usage ###Setup

var Up = require('up');

var upClient = new Up({
  username: JAWBONE_USERNAME,
  password: JAWBONE_PASSWORD
});

###Authenticating The UP API requires that an auth token is passed with each request. To generate the token, call the auth method.

upClient.auth(function(err, res){
  var token = res.token;
  console.log(token);
});

It's a good idea to make the auth request first and store the resulting token in your app for subsequent requests.

###Calling the Endpoints The only required parameter for each endpoint is the token.

client.feedSummary({_token: token}, function(err, res) {
	console.log(res);
});

Some endpoints accept further parameters, which are documented before each method in /lib/Up.js, as well as in Eric's API docs.

##Installation

npm install up

##Run Tests

  $ npm test