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:

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:

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

• ApiException
• HttpRequest
• HttpResponse