README

安装

您可以通过 composer 安装此包。

composer require jolitagrazyte/laravel-discogs

安装后

您必须在您的应用程序文件中设置此包的服务提供者。

// config/app.php
'provider' => [
    ...
    Jolita\LaravelDiscogs\DiscogsServiceProvider::class,
    ...
];

此包还附带了一个外观，它提供了一种调用类的方法。

// config/app.php
'aliases' => [
    ...
    'Discogs' => Jolita\LaravelDiscogs\DiscogsFacade::class,
    ...
];

接下来，您必须使用以下命令发布此包的配置文件

php artisan vendor:publish --provider="Jolita\LaravelDiscogs\DiscogsServiceProvider"

以下配置文件将发布在 config/laravel-discogs.php 中

某些端点需要身份验证。

如果您想使用这些中的一个，您必须设置您的令牌。

/*
 * Token is your discogs token that you can obtain on https://www.discogs.com/settings/developers page.
 * User-Agent is a name of your application, for example 'MyAmazingDiscogsApp/1.0'.
 *
 */
return [
    'token' => env('DISCOGS_TOKEN', ''),
    'headers' => [
        'User-Agent' => '',
    ],
];

用法

此包的用法非常简单。

对于大多数端点都有一个方法。

您也可以选择使用 get() 方法。

不需要身份验证的端点

// Get artist where id is 1.
$artist = Discogs::artist('1');

// Request all the relases of the artist where id is 1.   
$artistRelease = Discogs::artistRelease('1');

// Get label where id is 1.
$label = Discogs::label('1');

// Request all the relases of the label where id is 1.
$labelRelease = Discogs::labelRelease('1');

// Get relase where id is 1.
$release = Discogs::release('1');

// Get listing where id is 1234.
$listing = Discogs::getMarketplaceListing('1234')

未认证的库存

如果您不是库存所有者进行认证，则只能看到状态为 For Sale 的项目。

// Get inventory where username is username.
$inventory = Discogs::getUsersInventory('username')

需要身份验证的端点

对于需要身份验证的端点，您必须确保您在 .env 文件或直接在配置文件 config/laravel-discogs.php 中放置了一个令牌。

订单

$myOrders = Discogs::getMyOrders();

// Get order with id 1234
$order = Discogs::orderWithId('1234');

// Get messages of the order with id 1234
$orderMessages = Discogs::orderMessages('1234')

搜索

如果您想添加一些额外的搜索参数，您可以首先创建一个 SearchParameters 对象，然后链式调用尽可能多的选项。

// create a SearchParameters object
$searchParameters = new SearchParameters();

//chain some search paramater
$searchParameters->type('label')->format('lp')->year('1996');

//do a search request with query = 'MoWax' and passing the SearchParameters object
$searchResult = Discogs::search('MoWax', $searchParameters);

库存

请求您自己的库存时，您也必须进行身份验证。

作为库存所有者，您将获得额外的 weight、format_quantity、external_id 和 location 键。

// Get inventory where username is username.
$inventory = Discogs::getUsersInventory('username')

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

测试

$ composer test

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 hello@jolitagrazyte.com 联系，而不是使用问题跟踪器。

鸣谢

关于 Spatie

Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到所有开源项目的概述在这里。

许可

MIT 许可证 (MIT)。请参阅许可文件了解更多信息。

vladimilvasek / laravel-discogs

维护者

详细信息