jwilsson/spotify-web-api-php

A PHP wrapper for Spotify's Web API.

6.1.1 2024-10-09 19:01 UTC

Requires

• php: ^8.1
• ext-curl: *

Requires (Dev)

• php-coveralls/php-coveralls: ^2.5
• php-mock/php-mock-phpunit: ^2.7
• phpunit/phpunit: ^10.2
• squizlabs/php_codesniffer: ^3.0

MIT

• Jonathan Wilsson

• spotify

README

This is a PHP wrapper for Spotify's Web API. It includes the following:

• Helper methods for all API endpoints:
  • Information about artists, albums, tracks, podcasts, audiobooks, and users.
  • List music featured by Spotify.
  • Playlist and user music library management.
  • Spotify catalog search.
  • User playback control.
• Authorization flow helpers.
• Automatic refreshing of access tokens.
• Automatic retry of rate limited requests.
• PSR-4 autoloading support.

Requirements

• PHP 8.1 or later.
• PHP cURL extension (Usually included with PHP).

Installation

Install it using Composer:

composer require jwilsson/spotify-web-api-php

Usage

Before using the Spotify Web API, you'll need to create an app at Spotify’s developer site.

Note: Applications created after 2021-05-27 might need to perform some extra steps.

Simple example displaying a user's profile:

require 'vendor/autoload.php';

$session = new SpotifyWebAPI\Session(
    'CLIENT_ID',
    'CLIENT_SECRET',
    'REDIRECT_URI'
);

$api = new SpotifyWebAPI\SpotifyWebAPI();

if (isset($_GET['code'])) {
    $session->requestAccessToken($_GET['code']);
    $api->setAccessToken($session->getAccessToken());

    print_r($api->me());
} else {
    $options = [
        'scope' => [
            'user-read-email',
        ],
    ];

    header('Location: ' . $session->getAuthorizeUrl($options));
    die();
}

For more instructions and examples, check out the documentation.

The Spotify Web API Console can also be of great help when trying out the API.

Contributing

Contributions are more than welcome! See CONTRIBUTING.md for more info.

License

MIT license. Please see LICENSE.md for more info.