Wallogit.com
2017 © Pedro Peláez
The Discogs API makes it easy for developers to communicate with the Discogs platform
, (*1)
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., (*2)
This API is build upon the shoulders of a giant: Guzzle 4.0. This is an absolutely awesome library., (*3)
This library is released under the MIT license. See the complete license in the LICENSE file., (*4)
Start by installing composer. Next do:, (*5)
$ composer require ricbra/php-discogs-api
PHP >=5.4.0, (*6)
Creating a new instance is as simple as:, (*7)
<?php $client = Discogs\ClientFactory::factory([]);
Discogs requires that you supply a User-Agent. You can do this easily:, (*8)
<?php
$client = Discogs\ClientFactory::factory([
'defaults' => [
'headers' => ['User-Agent' => 'your-app-name/0.1 +https://www.awesomesite.com'],
]
]);
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:, (*9)
<?php $client = Discogs\ClientFactory::factory(); $client->getHttpClient()->getEmitter()->attach(new Discogs\Subscriber\ThrottleSubscriber());
Discogs API allow to access protected endpoints with either a simple Discogs Auth Flow or a more advanced (and more complex) Oauth Flow, (*10)
As stated in the Discogs Authentication documentation:, (*11)
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., (*12)
With the Discogs Php API you can add your credentials to each request by adding a query key to your own defaults like this:, (*13)
$client = ClientFactory::factory([
'defaults' => [
'query' => [
'key' => 'my-key',
'secret' => 'my-secret',
],
]
]);
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., (*14)
<?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'
]);
Another cool plugin is the History plugin:, (*15)
<?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'];
}
For more information about Guzzle and its plugins checkout the docs., (*16)
Per august 2014 a signed OAuth request is required for this endpoint., (*17)
<?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());
<?php
$label = $service->getLabel([
'id' => 1
]);
<?php
$artist = $service->getArtist([
'id' => 1
]);
<?php
$release = $service->getRelease([
'id' => 1
]);
echo $release['title']."\n";
<?php
$master = $service->getMaster([
'id' => 1
]);
echo $master['title']."\n";
Discogs returns the full url to images so just use the internal client to get those:, (*18)
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();
}
Authorization is required when folder_id is not 0., (*19)
<?php
$folders = $service->getCollectionFolders([
'username' => 'example'
]);
<?php
$folder = $service->getCollectionFolder([
'username' => 'example',
'folder_id' => 1
]);
<?php
$items = $service->getCollectionItemsByFolder([
'username' => 'example',
'folder_id' => 3
]);
Further documentation can be found at the Discogs API v2.0 Documentation., (*20)
Implemented a missing call? PR's are welcome!, (*21)
, (*22)
The Discogs API makes it easy for developers to communicate with the Discogs platform
MIT
api discogs