Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 2.38 KB

README.md

File metadata and controls

79 lines (49 loc) · 2.38 KB
Raw

Node.js API Wrapper

7digital

Current head build status:

Build Status

About 7digital

7digital.com is an online music store operating in over 16 countries and offering more than 11 million high quality DRM free MP3s (320kbps) from all major labels and wide range of idependent labels and distributors. 7digital API will give you access to the full catalogue including high quality album art, 30s preview clips for all tracks, commissions on sales, integrated purchasing and full length streaming. More details at developer.7digital.net

WHAT IS THIS?

A serverside javascript wrapper round the 7digital API with the ability to return XML or JSON responses.

INSTALLATION

The easiest way to use this wrapper is to install it via npm

npm install 7digital-api

or globally

sudo npm install -g 7digital-api

If you have a clean checkout of the code, you must update the git submodules before installing:

git submodule update --init --recursive

Then you can install via npm as usual (for npm >=1.0)

npm install  ../path/to/checkout

USAGE

See the examples folder for examples of how to use this. If you have included 7digital-api in your dependencies in the package.json file, you can use the like so:

var api = require('7digital-api'),
    artists = new api.Artists();

artists.getReleases({ artistid: 1 }, function(err, data) {
    console.dir(data);
});

If you need to supply your own config or want XML, you do so like this:

var api, artists;

api = require('7digital-api').configure({
    format: 'XML',
    oauthkey: 'MY_KEY_HERE',
    oauthsecret: 'MY_SECRET_HERE',
});

artists = new api.Artists();

artists.getReleases({ artistid: 1 }, function(err, data) {
    console.dir(data);
});	

See [developer.7digital.net](http://developer.7digital.net/) for full details of the API
endpoints and the parameters they accept.

WHAT DOES THIS SUPPORT?

The 7digital wrapper currently only supports the portions of the API which do not require OAUTH authentication. I.E. The catalogue API

To run the tests:

npm test