mrpc/beatportapi

Beatport API 类

1.0.0 2018-11-27 10:57 UTC

This package is auto-updated.

Last update: 2024-09-28 00:13:26 UTC


README

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

使用场景是服务器到服务器。

该类本质上只是返回一个数组,然后您可以按需操作。

这最初基于以下人员的作品

目标

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

需求

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

安装

composer require mrpc/beatportapi

使用

use mrpc\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版本,可能会在任何时候崩溃。不能保证按预期的方式工作,所以请自行承担风险。

待办事项

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

贡献

如果想要改进这个项目,欢迎提交错误报告、建议和拉取请求。不过,我无法保证有足够的时间进行大量工作!或者,您可以将其分支出来,创建自己的项目。

许可证

WFTPL,只要其他人同意。