README

本库是Discogs API v2.0的PHP 5.4实现。Discogs API是一个基于REST的接口。通过使用此库，您无需担心与API通信：所有困难的工作都已经完成了。

此API建立在巨人的肩膀上：Guzzle 4.0。
这是一个非常棒的库。

许可证

本库遵循MIT许可证发布。请参阅LICENSE文件中的完整许可证。

安装

首先安装composer。然后

$ composer require ricbra/php-discogs-api

需求

PHP >=5.4.0

用法

创建一个新的实例非常简单

<?php
$client = Discogs\ClientFactory::factory([]);

User-Agent

Discogs要求您提供User-Agent。您可以轻松地做到这一点

<?php
$client = Discogs\ClientFactory::factory([
    'defaults' => [
        'headers' => ['User-Agent' => 'your-app-name/0.1 +https://www.awesomesite.com'],
    ]
]);

限制速率

Discogs不喜欢您以过高的连接速率调用它们的API。使用ThrottleSubscriber来防止获得错误或被禁止

<?php

$client = Discogs\ClientFactory::factory();
$client->getHttpClient()->getEmitter()->attach(new Discogs\Subscriber\ThrottleSubscriber());

身份验证

Discogs API允许使用简单的Discogs Auth Flow或更高级（更复杂）的OAuth Flow访问受保护端点

Discogs身份验证

如Discogs身份验证文档所述

为了访问受保护端点，您需要根据您的具体情况注册消费者密钥和密钥或用户令牌

• 为了轻松访问您自己的用户账户信息，请使用用户令牌。
• 要访问需要身份验证的端点并构建第三方应用程序，请使用消费者密钥和密钥。

使用Discogs Php API，您可以将凭据添加到每个请求中，如下所示，通过向您的默认值添加一个query键

$client = ClientFactory::factory([
    'defaults' => [
        'query' => [
            'key' => 'my-key',
            'secret' => 'my-secret',
        ],
    ]
]);

OAuth

有许多端点需要OAuth。幸运的是，使用Guzzle这很简单。如果您在获取令牌和令牌密钥方面遇到困难，请参阅我的示例实现。

<?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'
]);

历史

另一个酷插件是历史插件

<?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'];
}

更多信息及插件

有关Guzzle及其插件的更多信息，请参阅文档。

执行搜索

截至2014年8月，此端点需要签名OAuth请求。

<?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返回图像的完整URL，因此只需使用内部客户端获取这些图像即可

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();
}

用户收藏

当folder_id不为0时，需要授权。

获取收藏夹

<?php

$folders = $service->getCollectionFolders([
    'username' => 'example'
]);

获取收藏夹

<?php

$folder = $service->getCollectionFolder([
    'username' => 'example',
    'folder_id' => 1
]);

按文件夹获取收藏夹项目

<?php

$items = $service->getCollectionItemsByFolder([
    'username' => 'example',
    'folder_id' => 3
]);

文档

更多信息请参阅Discogs API v2.0文档。

贡献

实现了缺失的调用？欢迎PR！