ericlagarda/beatportapi

Beatport Api Class

1.0 2016-08-12 12:24 UTC

This package is auto-updated.

Last update: 2020-09-12 13:58:07 UTC


README

A simple PHP class to query the Beatport API via Oauth, server side.

The use case is for a server to server context - for example I used it to build a simple Beatport RSS feed for my label. The library handles the three legged Oauth1a flow, submitting what would be the client side login/confirmation process via the server. Beatport does advertise a simpler Direct Access Token, but you need additional permissions, and this library works without that.

The class essentially just returns an array which you can then manipulate as you please.

This is originally based on the following people's work:

Aims

  • Login and query the Beatport API
  • Abstract away the OAuth pain
  • Send back a simple array with the query results

Requirements

  • PHP 5.5+
  • Beatport API Key and login details (You'll need to request those from Beatport)
  • Guzzle 6 (via composer)

Install

composer require moussaclarke/beatportapi

Usage

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

You can check the Beatport API documentation for which queries you can make and which parameters are required, although they are currently untested much beyond the above example, and not everything is documented, so your mileage may vary.

Disclaimer

Totally and utterly alpha, and likely to break at any point. Not guaranteed to work as intended in any way, so use at your own risk.

Todo

  • Store the tokens somewhere and re-use until expiry
  • Get some sanity into the variable / method names
  • Add some proper error catching / messaging
  • Test and document other query types.

Maintained

By Moussa Clarke

Contribute

Would be cool to improve this, so feel free to submit bug reports, suggestions and pull requests. Can't guarantee I've got enough time to do very much though! Alternatively just fork it and make your own thing.

License

WFTPL, insofar as those other guys are cool with that.

Music

Outside of geekdom, I'm a DJ, producer and label manager, go check me out: