An asynchronous nodejs wrapper for the etsy v2 api.
etsy-js is an asynchronous nodeJS wrapper for the etsy v2 api.
Install the latest stable version
$ npm install etsy-js
Bleeding edge version
$ git clone$ cd etsy-js$ npm install
The Etsy API has two modes: public, and authenticated. Public mode only requires an API key (available from http://developer.etsy.com ).
var etsyjs = ;var client = etsyjs;// direct API calls (GET / PUT / POST / DELETE)client;// or you can use some convenience methodsvar etsyUser = client;var etsySearch = client;var etsyShop = client;etsyUser;
You can make any non-authenticated calls to the API that you need.
The Etsy API has support for both retrieval of extended information and write support for authenticated users. Authentication can be performed from within a web application.
In authenticated mode, you need to set a client, secret and callbackURL.
var etsyjs = ;var client = etsyjs;
In this mode, you'll need to store the request token and secret before redirecting to the verification URL. A simple example in coffeescript using Express and Express Sessions:
express =session =cookieParser =url =etsyjs =# instantiate client with key and secret and set callback urlclient = etsyjsclientkey: nconfsecret: nconfcallbackURL: ''app =appappappget '/' req res ->client ->return consolelog err if errreqsessiontoken = responsetokenreqsessionsec = responsetokenSecretresredirect responseloginUrlappget '/authorise' req res -># parse the query string for OAuth verifierquery = urlquery;verifier = queryoauth_verifier# final part of OAuth dance request access token and secret with given verifierclientaccessToken reqsessiontoken reqsessionsec verifier err response -># update our session with OAuth token and secretreqsessiontoken = responsetokenreqsessionsec = responsetokenSecretresredirect '/find'appget '/find' req res -># we now have OAuth credentials for this session and can perform authenticated requestsclient ->consolelog err if errconsoledirbody if bodyressend bodyresults0 if bodyserver = applisten 3000 ->consolelog 'Listening on port %d' serverport
All the callbacks fwill take first an error argument, then a data argument, like this:
Pagination is supported, simply pass through params as follows:
var params =keywords: "rainbow"offset: 1limit: 25;client;
More examples to come...
$ grunt test
Please submit and bugs to this project and I will fix them. Pull requests also welcome.
Thanks to the ruby etsy api wrapper as I used their fixture tests data for the etsy-js tests and README outline. Thanks to octonode for the inspiration to make this API in coffeescript.