spotify-api-sdk

Getting Started with Spotify Web API

Introduction

You can use Spotify's Web API to discover music and podcasts, manage your Spotify library, control audio playback, and much more. Browse our available Web API endpoints using the sidebar at left, or via the navigation bar on top of this page on smaller screens.

In order to make successful Web API requests your app will need a valid access token. One can be obtained through OAuth 2.0.

The base URI for all Web API requests is https://api.spotify.com/v1.

Need help? See our Web API guides for more information, or visit the Spotify for Developers community forum to ask questions and connect with other developers.

Install the Package

Install the gem from the command line:

gem install spotify-api-sdk -v 1.0.0

Or add the gem to your Gemfile and run bundle:

gem 'spotify-api-sdk', '1.0.0'

For additional gem details, see the RubyGems page for the spotify-api-sdk gem.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
connection	Faraday::Connection	The Faraday connection object passed by the SDK user for making requests
adapter	Faraday::Adapter	The Faraday adapter object passed by the SDK user for performing http requests
timeout	Float	The value to use for connection timeout. Default: 60
max_retries	Integer	The number of times to retry an endpoint call if it fails. Default: 0
retry_interval	Float	Pause in seconds between retries. Default: 1
backoff_factor	Float	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
retry_statuses	Array	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array	A list of HTTP methods to retry. Default: %i[get put]
http_callback	HttpCallBack	The Http CallBack allows defining callables for pre and post API calls.
authorization_code_auth_credentials	AuthorizationCodeAuthCredentials	The credential object for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

client = SpotifyWebApi::Client.new(
  authorization_code_auth_credentials: AuthorizationCodeAuthCredentials.new(
    o_auth_client_id: 'OAuthClientId',
    o_auth_client_secret: 'OAuthClientSecret',
    o_auth_redirect_uri: 'OAuthRedirectUri',
    o_auth_scopes: [
      OAuthScopeEnum::APP_REMOTE_CONTROL,
      OAuthScopeEnum::PLAYLIST_READ_PRIVATE
    ]
  ),
  environment: Environment::PRODUCTION
)

API calls return an ApiResponse object that includes the following fields:

Field	Description
status_code	Status code of the HTTP response
reason_phrase	Reason phrase of the HTTP response
headers	Headers of the HTTP response as a Hash
raw_body	The body of the HTTP response as a String
request	HTTP request info
errors	Errors, if they exist
data	The deserialized body of the HTTP response

Authorization

This API uses the following authentication schemes.

• oauth_2_0 (OAuth 2 Authorization Code Grant)

List of APIs

• Albums
• Artists
• Audiobooks
• Categories
• Chapters
• Episodes
• Genres
• Markets
• Player
• Playlists
• Search
• Shows
• Tracks
• Users

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest