node-red-contrib-spotify

Node-RED node for Spotify Web API

This node for Node-RED is a wrapper for spotify-web-api-node.

Features

The package contains two nodes. One configuration node to setup the OAuth2 authentication using a Client id and a Client secret. The function node is to select the API function which you want to use.

How to install

Run the following command in the root directory of your Node-RED installation

npm install node-red-contrib-spotify

or

yarn add node-red-contrib-spotify

Configuration

Authentication

• Head to the Spotify Developer Dashboard.
• Create a new application by selecting CREATE A CLIENT ID
• Select the created application, click EDIT SETTINGS and add a new Redirect URI.

  <node-red-ip:port>/spotify-credentials/auth/callback
  
  // e.g. if you're running node-red on localhost
  http://localhost:1880/spotify-credentials/auth/callback
  

• Click save and copy the Client ID and Client Secret.
• Paste the Client ID and Client Secret in the Spotify Config node in Node-RED.
• Enter the required scopes. A list of all available scopes can be found on the Authorization Scopes page.
• Press Start Authentication and allow the access for your Spotify account.

Usage

Some API functions require extra parameters. To define parameters, use the msg.params object and define an array with all required arguments. Check out the API description for more information about available functions.

Example:

// API function: getArtistAlbums
msg.params = [
    '43ZHCT0cAZBISjO8DG9PnE', /* Artist ID */
    { limit: 10, offset: 20 } /* Options */
];