ericlagarda/beatportapi

Beatport API 类

1.0 2016-08-12 12:24 UTC

This package is auto-updated.

Last update: 2024-09-12 22:32:57 UTC


README

一个简单的PHP类,通过OAuth在服务器端查询Beatport API。

使用场景是服务器到服务器的上下文 - 例如,我用它为我的厂牌构建了一个简单的Beatport RSS源。这个库处理了三脚Oauth1a流程,通过服务器提交客户端登录/确认过程。Beatport确实宣传了一个更简单的直接访问令牌,但你需要额外的权限,而这个库不需要。

该类本质上只是返回一个数组,然后你可以随意操作。

这最初基于以下人士的工作

目标

  • 登录并查询Beatport API
  • 抽象OAuth的痛苦
  • 返回一个简单的数组,包含查询结果

要求

  • PHP 5.5+
  • Beatport API密钥和登录详细信息(您需要从Beatport请求这些)
  • Guzzle 6(通过composer)

安装

composer require moussaclarke/beatportapi

用法

use MoussaClarke\BeatportApi;

// auth parameters
$parameters = [
  'consumer'=> 'CONSUMERKEY', // Your Beatport API Key
  'secret' => 'SECRETKEY', // Your Beatport Secret Key
  'login' => 'BEATPORTLOGIN', // Your Beatport Login Name
  'password' => 'BEATPORTPASSWORD' // Your Beatport Password
  ];

// query parameters
$query = [
  'facets' => 'labelId:xyz', // The filter type
  'method' => 'releases', // The Beatport API Method
  'perPage' => '150' // Number of results per page
  ];

$api = new BeatportApi ($parameters); // initialise
$response = $api->queryApi ($query); // run the query
print_r ($response); // do something with response

您可以在Beatport API文档中查看可以进行的查询和所需的参数,尽管它们目前仅限于上述示例,并且并非所有内容都有文档,因此效果可能会有所不同。

免责声明

完全和彻底的alpha版本,可能会在任何时候崩溃。不能保证按预期工作,因此请自行承担风险。

待办事项

  • 将令牌存储在某处并在到期前重复使用
  • 使变量/方法名称更合理
  • 添加一些适当的错误处理/消息
  • 测试和记录其他查询类型。

维护

Moussa Clarke

贡献

改进这个项目会很好,所以请随时提交错误报告、建议和pull请求。但我不能保证有足够的时间去做很多!或者,您可以分叉它并创建自己的东西。

许可证

WFTPL,只要其他人都同意。

音乐

在技术领域之外,我是一个DJ、制作人厂牌经理,去看看我吧