Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khilnani/soundclouder.js
Node.js based SDK for the SoundCloud platform API
https://github.com/khilnani/soundclouder.js
javascript node-module nodejs soundcloud soundcloud-api
Last synced: about 1 month ago
JSON representation
Node.js based SDK for the SoundCloud platform API
- Host: GitHub
- URL: https://github.com/khilnani/soundclouder.js
- Owner: khilnani
- License: mit
- Created: 2012-12-25T15:55:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-11-23T19:34:56.000Z (almost 6 years ago)
- Last Synced: 2024-09-26T20:54:57.281Z (about 2 months ago)
- Topics: javascript, node-module, nodejs, soundcloud, soundcloud-api
- Language: JavaScript
- Homepage: https://npmjs.com/package/soundclouder
- Size: 47.9 KB
- Stars: 36
- Watchers: 5
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*
- [soundclouder.js [](https://travis-ci.org/khilnani/soundclouder.js)](#soundclouderjs-!build-statushttpsapitravis-ciorgkhilnanisoundclouderjspngbranch=masterhttpstravis-ciorgkhilnanisoundclouderjs)
- [SoundCloud APIs Implemented](#soundcloud-apis-implemented)
- [Usage](#usage)
- [Links](#links)
- [Installation](#installation)
- [Global](#global)
- [Project](#project)
soundclouder.js [](https://travis-ci.org/khilnani/soundclouder.js)
===============
> SoundCloud API for Node.js.
NPM Module Info - https://www.npmjs.org/package/soundclouder
SoundCloud APIs Implemented
===============
- Connection/Authorization Url
- OAuth Authorization (/oauth2/token)
- General GET, PUT, POST and DELETE.
Usage
==============
In your *node.js* application -
```javascript
// Include the soundclouder library
var sc = require("soundclouder");
// Update the logging level
// See: https://github.com/khilnani/dysf.utils
// Also see: test/test.js
var log = require("dysf.utils").logger
// 0: system, 1: error, 2: warn, 3: event, 4: info,
// 5: debug, 6: trace. Default is 4 (info)
// Set to debug
log.setLogLevel(5);
// client id, secret and redirect url are the values obtained from
// http://soundcloud.com/you/apps
sc.init(sc_client_id, sc_client_secret, sc_redirect_uri);
```
Once you have created an application at http://soundcloud.com/you/apps, you need to use the SoundCloud Javascript library to authenticate a user and get a 'code'.
The code below, will prompt the user to authorize your application. The user's browser will be redirected to the REDIRECT_URI you specified in the SoundCloud application setup. This REDIRECT_URI will be sent a Request paramater 'code'
*Sample html code*
```html
SC.initialize({
client_id: "CLIENT_ID",
redirect_uri: "REDIRECT_URI",
display: 'popup'
});
SC.connect(function () {
console.log("Connected to SoundCloud");
alert("Connected to SoundCloud");
});
```
SoundCloud will redirect the user to `REDIRECT_URI?code=CODE`. Eg. `http://SITE/sc_redirect?code=CODE`
If you are using Express.js, you can setup a route for the REDIRECT_URI - eg.`http://SITE/sc_redirect`.
*Sample Express.js code*
```javascript
var express = require('express'),
sc = require("soundclouder"),
app = express();
// Define the route handler for /sc_redirect
function scRedirectHandler (request, response) {
// get the 'code' paramater from the request
var code = request.query.code;
// authorize and get an access token
sc.auth(code, function (error, access_token) {
if (error) {
console.error(error.message);
} else {
// Store the access_token somewhere, perhaps the user's session
console.log('access_token=' + access_token );
// call subsequent calls to SoundCloud
// send the method the saved access_token for the user
sc.get('/tracks/11222211', access_token, function (error2, data) {
console.log( data.title );
});
}
});
// send dummy html back to the browser
response.send("code: " + code + "sudo npm install soundclouder -g
- Usually installed at - /usr/local/lib/node_modules/soundclouder
Project
---------
- Add "soundclouder": "x.x.x" to the dependencies section of your project's package.json
- Example "dependencies": { "soundclouder": "x.x.x" }
- Run npm install in the director with your package.json
- Usually installed at - PROJECT_DIR/node_modules/soundclouder