Jawbone UP API Node.js Client
API Version: v.1.1
Official UP API: jawbone.com/up/developer
npm install jawbone-up --saveAn access_token attribute is required in the options object!
See below for an example of how this could be done. This library does not
assist in getting an access_token through OAuth, but once you get the token,
it will apparently last for a year.
A client_secret attribute is required if you would like to use up.refreshToken.get() to get new refresh tokens. It is not required otherwise.
var options = {
// ** REQUIRED **
access_token: 'xyz' // Access token for specific user,
client_secret: 'abc' // Client Secret (required for up.refreshToken.get())
}
var up = require('jawbone-up')(options);Official UP API can be found at jawbone.com/up/developer
Example callback:
// Callback function returns an error if applicable
// and/or the body of the API response
function callback(err, body) {
if(err) {
console.log('Error: ' + err);
}
else {
var data = JSON.parse(body).data;
// do something with data
}
}// get user info
up.me.get({}, callback) // GET /nudge/api/v.1.1/users/@me/
// get friends of user
up.friends.get({}, callback) // GET /nudge/api/v.1.1/users/@me/friends
// get mood of user
up.mood.get({}, callback) // GET /nudge/api/v.1.1/users/@me/mood
// get trends of user
up.trends.get({}, callback) // GET /nudge/api/v.1.1/users/@me/trends
// get goals of user
up.goals.get({}, callback) // GET /nudge/api/v.1.1/users/@me/goals// get all moves (paginated results)
up.moves.get({}, callback) // GET /nudge/api/v.1.1/users/@me/moves
// get a specific moves
up.moves.get({ xid : move_xid }, callback) // GET /nudge/api/v.1.1/moves/{move_xid}
// get a specific move image
up.moves.image({ xid : move_xid }, callback) // GET /nudge/api/v.1.1/moves/{move_xid}/image
// get a specific move intensity
up.moves.ticks({ xid : move_xid }, callback) // GET /nudge/api/v.1.1/moves/{move_xid}/ticks// get all workouts (paginated results)
up.workouts.get({}, callback) // GET /nudge/api/v.1.1/users/@me/workouts
// create a new workout
up.workouts.create(options, callback) // POST /nudge/api/v.1.1/users/@me/workouts
// get a specific workout
up.workouts.get({ xid : workout_xid }, callback) // GET /nudge/api/v.1.1/workouts/{workout_xid}
// update a specific workout
up.workouts.update(options, callback) // POST https://jawbone.com/nudge/api/v.1.1/workouts/{xid}/partialUpdate
// get a specific workout image
up.workouts.image({ xid : workout_xid }, callback) // GET /nudge/api/v.1.1/workouts/{workout_xid}/image
// get a specific workout intensity
up.workouts.ticks({ xid : workout_xid }, callback) // GET /nudge/api/v.1.1/workouts/{workout_xid}/ticks// get all sleeps (paginated results)
up.sleeps.get({}, callback) // GET /nudge/api/v.1.1/users/@me/sleeps
// get a specific sleep
up.sleeps.get({ xid : sleep_xid }, callback) // GET /nudge/api/v.1.1/sleeps/{sleep_xid}
// create a new sleep
up.sleeps.create(options, callback) // POST /nudge/api/v.1.1/users/@me/sleeps
// get a specific sleep image
up.sleeps.image({ xid : sleep_xid }, callback) // GET /nudge/api/v.1.1/sleeps/{sleep_xid}/image
// get a specific sleep ticks
up.sleeps.ticks({ xid : sleep_xid }, callback) // GET /nudge/api/v.1.1/sleeps/{sleep_xid}/ticks
// delete a specific sleep
up.sleeps.delete({ xid : sleep_xid }, callback) // DELETE /nudge/api/v.1.1/sleeps/{sleep_xid}// get all meals (paginated results)
up.meals.get({}, callback) // GET /nudge/api/v.1.1/users/@me/meals
// create a new meal
up.meals.create(options, callback) // POST /nudge/api/v.1.1/users/@me/meals
// update a specific meal
up.meals.update(options, callback) // POST https://jawbone.com/nudge/api/v.1.1/meals/{xid}/partialUpdate
// get a specific meal
up.meals.get({ xid : meal_xid }, callback) // GET /nudge/api/v.1.1/meals/{meal_xid}// get all body events (paginated results)
up.events.body.get({}, callback) // GET /nudge/api/v.1.1/users/@me/body_events
// get a specific body event
up.events.body.get({ xid : event_xid }, callback) // GET /nudge/api/v.1.1/body_events/{event_xid}
// create a new body event
up.events.body.create(options, callback) // POST /nudge/api/v.1.1/users/@me/body_events
// delete a specific body event
up.events.body.delete({ xid : event_xid }, callback) // DELETE /nudge/api/v.1.1/body_events/{event_xid}// get all cardiac events (paginated results)
up.events.cardiac.get({}, callback) // GET /nudge/api/v.1.1/users/@me/cardiac_events
// get a specific cardiac event
up.events.cardiac.get({ xid : event_xid }, callback) // GET /nudge/api/v.1.1/cardiac_events/{event_xid}
// create a new cardiac event
up.events.cardiac.create(options, callback) // POST /nudge/api/v.1.1/users/@me/cardiac_events
// delete a specific cardiac event
up.events.cardiac.delete({ xid : event_xid }, callback) // DELETE /nudge/api/v.1.1/cardiac_events/{event_xid}// get all generic events (paginated results)
up.events.generic.get({}, callback) // GET /nudge/api/v.1.1/users/@me/generic_events
// get a specific generic event
up.events.generic.get({ xid : event_xid }, callback) // GET /nudge/api/v.1.1/generic_events/{event_xid}
// create a new generic event
up.events.generic.create(options, callback) // POST /nudge/api/v.1.1/users/@me/generic_events
// update an existing generic event
up.events.generic.update(options, callback) // POST /nudge/api/v.1.1/users/@me/generic_events/{xid}/partialUpdate
// delete a specific generic event
up.events.generic.delete({ xid : event_xid }, callback) // DELETE /nudge/api/v.1.1/generic_events/{event_xid}// get all moods (paginated results)
up.mood.get({}, callback) // GET /nudge/api/v.1.1/users/@me/mood
// get a specific mood
up.mood.get({ xid : mood_xid }, callback) // GET /nudge/api/v.1.1/mood/{mood_xid}
// create a new mood
up.mood.create(options, callback) // POST /nudge/api/v.1.1/users/@me/mood
// delete a specific mood
up.mood.delete({ xid : mood_xid }, callback) // DELETE /nudge/api/v.1.1/mood/{mood_xid}// get a user's timezone
up.timezone.get({}, callback) // GET /nudge/api/v.1.1/users/@me/timezoneAdded in v.1.1
// get (technically POST) a refresh token (requires client_secret passed into options when initializing)
up.refreshToken.get(callback) // POST /nudge/api/v.1.1/users/@me/refreshTokenAdded in v.1.1
// get user settings
up.settings.get(callback) // GET /nudge/api/v.1.1/users/@me/settingsAdded in v.1.1
// create a webhook
up.webhook.create(webhook_url, callback) // POST /users/@me/pubsub?webhook={webhook_url};
// delete a webhook
up.webhook.delete(callback) // DELETE /users/@me/pubsubTests can be found in the test folder.
To run tests:
Make sure you first have dependencies installed by running:
npm installThen you may run all the tests with:
npm testMIT © 2014 Ryan Seys