blitzr/api-client-bundle

The official Blitzr API Client for Symfony

1.0.0 2016-01-25 15:09 UTC

Requires

• blitzr/php-client: 1.*

MIT

• Blitzr

• blitzr api bundle

README

A PHP API client bundle for the Blitzr API.

To use this bundle you will need an API key, you can request it at : https://blitzr.io.

Documentation

This service implements all the methods from the official Blitzr PHP client. Also you can use the PHP client documentation as a reference for this bundle.

You can also refer to the official Blitzr API reference to have more informations.

Installation

First add BlitzrApiClientBundle to your composer requirements.

$ composer require blitzr/api-client-bundle

Then enable the bundle in the Kernel.

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Blitzr\ApiClientBundle\BlitzrApiClientBundle(),
        // ...
    );
}

Add the API key to your configuration.

// app/config/config.yml

...

# BlitzrApiClientBundle
blitzr_api_client:
    api_key: "your_api_key"

That's all !

Getting Started

This bundle provides you a service, let's take an example of how to get an Artist or a Tag.

// Get the service
$blitzrClient = $this->get('blitzr_api_client.client');

// Request the artist
$artist = $blitzrClient->getArtist('year-of-no-light');

// Request a tag
$tag = $blitzrClient->getTag('rock');