node-kippt

A wrapper for the Kippt API.

Installation

You can install using Node Package Manager (npm)

npm install node-kippt

Or define in your package.json dependencies

Usage

Refer to the Kippt developer API page for information about the API response.

Initialize

varKippt=require('node-kippt');// Initialize the KipptAPI// You can easily obtain the API token by running// curl --user name:password https://kippt.com/api/account/varkippt=newKippt.KipptAPI({username: 'YOUR_USERNAME',api_token: 'API_TOKEN'});

Clips API

// Returns the full clips listingkippt.clips.all(function(error,data){if(!error)console.log(data);});// Returns the clip information associated with a clip IDkippt.clips.getById(CLIP_ID,function(error,data){if(!error)console.log(data);});// add to the clips listkippt.clips.add({url: "Clip's url",// requiredtitle: "Clip's title",list: "resource_uri for clip's list",notes: "Notes for the clip",is_starred: Boolean,is_read_later: Boolean},function(error,data){if(!error)console.log(data);});// update the clip, refer to above optionskippt.clips.update({id: CLIP_ID,// requireother_options: ''// refer to above options},function(error,data){if(!error)console.log(data);});// remove the clipkippt.clips.remove(CLIP_ID,function(error,data){if(!error)console.log('SUCCESS');});// search clipskippt.clips.search({q: 'search_query',is_starred: Boolean},function(error,data){if(!error)console.log(data);});

Lists API

// Returns the full lists objectkippt.lists.all(function(error,data){if(!error)console.log(data);});// Returns the list information associated with a list IDkippt.lists.getById(LIST_ID,function(error,data){if(!error)console.log(data);});// add to the listkippt.lists.add({title: "list title",// requiredis_private: Boolean},function(error,data){if(!error)console.log(data);});// update the listkippt.lists.update({id: LIST_ID,// requiretitle: "list title",is_private: Boolean},function(error,data){if(!error)console.log(data);});// remove an item from the listkippt.lists.remove(LIST_ID,function(error,data){if(!error)console.log('SUCCESS');});