README

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

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "sdksio/spotify-api-sdk:1.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "sdksio/spotify-api-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/sdksio/spotify-api-sdk#1.0.0

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`
`timeout`	`int`	Timeout for API calls in seconds. Default: `0`
`enableRetries`	`bool`	Whether to enable retries and backoff feature. Default: `false`
`numberOfRetries`	`int`	The number of retries to make. Default: `0`
`retryInterval`	`float`	The retry time interval between the endpoint calls. Default: `1`
`backOffFactor`	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
`maximumRetryWaitTime`	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
`retryOnTimeout`	`bool`	Whether to retry on request timeout. Default: `true`
`httpStatusCodesToRetry`	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
`httpMethodsToRetry`	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
`authorizationCodeAuth`	`AuthorizationCodeAuth`	The Credentials Setter for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

$client = SpotifyWebAPIClientBuilder::init()
    ->authorizationCodeAuthCredentials(
        AuthorizationCodeAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret',
            'OAuthRedirectUri'
        )
            ->oAuthScopes(
                [
                    OAuthScopeEnum::APP_REMOTE_CONTROL,
                    OAuthScopeEnum::PLAYLIST_READ_PRIVATE
                ]
            )
    )
    ->environment('production')
    ->build();

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

Field	Description
`getStatusCode`	Status code of the HTTP response
`getHeaders`	Headers of the HTTP response as a Hash
`getResult`	The deserialized body of the HTTP response as a String

sdksio / spotify-api-sdk

Maintainers

Details

README

Introduction

Install the Package

Initialize the API Client

Authorization

List of APIs

Classes Documentation