ricbra / php-discogs-api
The Discogs API makes it easy for developers to communicate with the Discogs platform
Installs: 7 072
Dependents: 1
Suggesters: 0
Security: 0
Stars: 151
Watchers: 23
Forks: 90
Open Issues: 8
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~5.0
- guzzlehttp/guzzle-services: ~0.5.0
- guzzlehttp/oauth-subscriber: ~0.2
Requires (Dev)
- phpunit/phpunit: ~4
Suggests
- ricbra/discogs-bundle: For integrating Discogs into Symfony2
README
This library is a PHP 5.4 implementation of the Discogs API v2.0. The Discogs API is a REST-based interface. By using this library you don't have to worry about communicating with the API: all the hard work has already be done.
This API is build upon the shoulders of a giant: Guzzle 4.0. This is an absolutely awesome library.
Deprecated
This repository is outdated and not maintained anymore. Please see https://github.com/calliostro/php-discogs-api for a more up to date version.
License
This library is released under the MIT license. See the complete license in the LICENSE file.
Installation
Start by installing composer. Next do:
$ composer require ricbra/php-discogs-api
Requirements
PHP >=5.4.0
Usage
Creating a new instance is as simple as:
<?php $client = Discogs\ClientFactory::factory([]);
User-Agent
Discogs requires that you supply a User-Agent. You can do this easily:
<?php $client = Discogs\ClientFactory::factory([ 'defaults' => [ 'headers' => ['User-Agent' => 'your-app-name/0.1 +https://www.awesomesite.com'], ] ]);
Throttling
Discogs doesn't like it when you hit their API at a too high connection rate. Use the ThrottleSubscriber
to
prevent getting errors or banned:
<?php $client = Discogs\ClientFactory::factory(); $client->getHttpClient()->getEmitter()->attach(new Discogs\Subscriber\ThrottleSubscriber());
Authentication
Discogs API allow to access protected endpoints with either a simple Discogs Auth Flow or a more advanced (and more complex) Oauth Flow
Discogs Auth
As stated in the Discogs Authentication documentation:
In order to access protected endpoints, you’ll need to register for either a consumer key and secret or user token, depending on your situation:
- To easily access your own user account information, use a User token.
- To get access to an endpoint that requires authentication and build 3rd party apps, use a Consumer Key and Secret.
With the Discogs Php API you can add your credentials to each request by adding a query
key to your own defaults like this:
$client = ClientFactory::factory([ 'defaults' => [ 'query' => [ 'key' => 'my-key', 'secret' => 'my-secret', ], ] ]);
OAuth
There are a lot of endpoints which require OAuth. Lucky for you using Guzzle this is peanuts. If you're having trouble obtaining the token and token_secret, please check out my example implementation.
<?php $client = Discogs\ClientFactory::factory([]); $oauth = new GuzzleHttp\Subscriber\Oauth\Oauth1([ 'consumer_key' => $consumerKey, // from Discogs developer page 'consumer_secret' => $consumerSecret, // from Discogs developer page 'token' => $token['oauth_token'], // get this using a OAuth library 'token_secret' => $token['oauth_token_secret'] // get this using a OAuth library ]); $client->getHttpClient()->getEmitter()->attach($oauth); $response = $client->search([ 'q' => 'searchstring' ]);
History
Another cool plugin is the History plugin:
<?php $client = Discogs\ClientFactory::factory([]); $history = new GuzzleHttp\Subscriber\History(); $client->getHttpClient()->getEmitter()->attach($history); $response = $client->search([ 'q' => 'searchstring' ]); foreach ($history as $row) { print (string) $row['request']; print (string) $row['response']; }
More info and plugins
For more information about Guzzle and its plugins checkout the docs.
Perform a search:
Per august 2014 a signed OAuth request is required for this endpoint.
<?php $response = $client->search([ 'q' => 'Meagashira' ]); // Loop through results foreach ($response['results'] as $result) { var_dump($result['title']); } // Pagination data var_dump($response['pagination']); // Dump all data var_dump($response->toArray());
Get information about a label:
<?php $label = $service->getLabel([ 'id' => 1 ]);
Get information about an artist:
<?php $artist = $service->getArtist([ 'id' => 1 ]);
Get information about a release:
<?php $release = $service->getRelease([ 'id' => 1 ]); echo $release['title']."\n";
Get information about a master release:
<?php $master = $service->getMaster([ 'id' => 1 ]); echo $master['title']."\n";
Get image
Discogs returns the full url to images so just use the internal client to get those:
php
$release = $client->getRelease([
'id' => 1
]);
foreach ($release['images'] as $image) {
$response = $client->getHttpClient()->get($image['uri']);
// response code
echo $response->getStatusCode();
// image blob itself
echo $client->getHttpClient()->get($image['uri'])->getBody()->getContents();
}
User Collection
Authorization is required when folder_id
is not 0
.
Get collection folders
<?php $folders = $service->getCollectionFolders([ 'username' => 'example' ]);
Get collection folder
<?php $folder = $service->getCollectionFolder([ 'username' => 'example', 'folder_id' => 1 ]);
Get collection items by folder
<?php $items = $service->getCollectionItemsByFolder([ 'username' => 'example', 'folder_id' => 3 ]);
Documentation
Further documentation can be found at the Discogs API v2.0 Documentation.
Contributing
Implemented a missing call? PR's are welcome!