soundcloudnodejs
v3.0.1
Published
The missing NodeJS Wrapper for SoundCloud API
Downloads
10
Maintainers
Readme
#soundcloudnodejs
The missing Async NodeJS Wrapper for SoundCloud API soundcloudnodejs is a nodejs module to access soundcloud from NodeJS.
Install
npm install --save soundcloudnodejs
Register
Register your app http://soundcloud.com/you/apps/new
Example Code to get your Token Access from SoundCloud API
var soundcloudnodejs = require("soundcloudnodejs");
var options = {
client_id: "your_client_id",
client_secret: "your_client_secret",
grant_type: "password",
username: "your_username",
password: "your_password",
redirect_uri: "your_redirect_uri"
}
soundcloudnodejs.getToken(options).then(function (token, meta) {
console.log(token.access_token)
});
- For usage see folder soundcloudnodejs/example/ .
- For test cases and BDD scenarios see folder soundcloudnodejs/test/ .
- Make sure to add your credentials to credentials.js and run
npm run token
before running the tests, otherwise tests will fail.
DEBUG
To enable debug mode, run scripts with env variable SOUNDCLOUDJS_DEBUG=true
License
The MIT License (MIT)
Copyright (c) 2018 Thomas Modeneis
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Disclaimer:
- I've done this module because SoundCloud does not offer a NodeJS wrapper for their APIs, other opensource modules where not working or not maintained when I started this SoundCloud saga back in 2016.
- This module is fully tested and functional, however if something does not work for you please feel free to open a ticket / pull request with a fix or new functionality.