https://github.com/zachwinter/spotify-auth-express

Plug-and-play Spotify OAUTH flow for Express.
https://github.com/zachwinter/spotify-auth-express

javascript nodejs oauth2 spotify spotify-api

Last synced: 2 months ago
JSON representation

Plug-and-play Spotify OAUTH flow for Express.

• Host: GitHub
• URL: https://github.com/zachwinter/spotify-auth-express
• Owner: zachwinter
• License: mit
• Created: 2020-07-28T10:58:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T09:59:39.000Z (about 2 years ago)
• Last Synced: 2024-08-30T05:22:07.098Z (4 months ago)
• Topics: javascript, nodejs, oauth2, spotify, spotify-api
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# spotify-auth-express

### Plug-and-play Spotify OAUTH flow for Express.

You can either initialize a new Express API:

```js

const spotify = require('spotify-auth-express')

const app = spotify({

  client: 'CLIENT_ID_HERE',

  secret: 'CLIENT_SECRET_HERE'

})

```

... or extend an existing one:

```js

const express = require('express')

const spotify = require('spotify-auth-express')

const app = express()

spotify({

  app,

  client: 'CLIENT_ID_HERE',

  secret: 'CLIENT_SECRET_HERE'

})

app.listen(...)

```

In return, you get:

```js

app.get('/spotify/auth', (req, res) => {

  ...

  res.redirect('YOUR_REDIRECT_URL')

})

app.get('/spotify/callback/' ...)

app.get('/spotify/refresh/' ...)

```

#### Configuration

The following optional keys can be passed in addition to your application & client IDs:

* app | `express application instance` | default: `null`

* scope | `String` | default: `'streaming user-read-email user-read-private user read-playback-state user-modify-playback-state'`

* port | `Number` | default: `6868`

* payload | `String` | default: `'COOKIE'` / `'QUERY_PARAM'` | default: `'COOKIE'`

* setCrossOrigin | `Boolean` | default: `true`

* crossOrigin | `String` | default: `'*'` 

* root | `String` | default: `'/spotify'`

* intialize | `Boolean` | default: `false`

* gzip | `Boolean` | default: true`

* redirect | `String` | default: \``http://localhost:${config.port || DEFAUL_PORT}${config.root || DEFAULT_ROOT}${config.redirect || DEFAULT_REDIRECT}`\`

* accessTokenKey | `String` |  default: `'SPOTIFY_ACCESS_TOKEN'`,

* refreshTokenKey | `String` | default: `'SPOTIFY_REFRESH_TOKEN'`,

* spotifyAuthUrl | `String` | defailt: `https://accounts.spotify.com/authorize?`

* spotifyTokenUrl | `String` | default: `https://accounts.spotify.com/api/token`