websoftwares/avin

Avin, avin.cc api client

dev-master 2013-07-30 14:25 UTC

Requires

• php: >=5.3.0
• ext-curl: *
• ext-json: *

Requires (Dev)

• phpunit/phpunit: 3.7.*

DBAD

• Boris Verhaaff

• api
• avin

README

Client for interacting with the avin.cc JSON RESTful api.

Documentation

We encourage you to read the documentation carefully before proceeding.

Api Key

The AVIN API requires a developer key which you can ask avin.cc using this email address: [e-mail].

Installing via Composer (recommended)

Install composer in your project:

curl -s http://getcomposer.org/installer | php

Create a composer.json file in your project root:

{
    "require": {
        "websoftwares/avin": "dev-master"
    }
}

Install via composer

php composer.phar install

Usage

Below u find a list with available methods.

GetWineByAvin

Gets a wine by Avin.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));
$avin->GetWineByAvin('AVIN0123456789012');

GetWinesByName

Gets wine by name.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));
$avin->GetWinesByName('Era');

GetCountries

Gets a list of countries.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));
$avin->GetCountries();

GetWineTypes

Gets a list of wine types.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));
$avin->GetWineTypes();

GetProducerByID

Gets a producer by id.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));
$avin->GetProducerByID(12345);

GetProducerByName

Gets a producer by name.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));
$avin->GetProducerByName('Producer sample name');

setFilter

Please read the documentation for a complete list of available filters.

use Websoftwares\AvinClient, Websoftwares\Avin;

$avin = new Avin(new AvinClient('123456789YourApiKey'));

$avin
	->setFilter('vintage', 2003)
    ->setFilter('country', 620)
    ->setFilter('type', '1')
    ->setFilter('producer', 'Cortes de Cima')
    ->GetWineByAvin('AVIN6452997073019');

Error messages

Use try/catch block to get error messages.

use Websoftwares\AvinClient,
	Websoftwares\Avin,
	Websoftwares\AvinException;

try {
	$avin = new Avin(new AvinClient('123456789YourApiKey'));
	$avin->GetWinesByName('Era');
} catch (AvinException $e) {
	echo $e->getMessage();
}

Testing

In the tests folder u can find several tests for online and offline.