websoftwares/avin

Avin, avin.cc api client

Avin

Client for interacting with the avin.cc JSON RESTful api., _(*1)

, _(*2)

Documentation

We encourage you to read the documentation carefully before proceeding., _(*3)

Api Key

The AVIN API requires a developer key which you can ask avin.cc using this email address: info@avin.cc., _(*4)

Installing via Composer (recommended)

Install composer in your project:, _(*5)

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

Create a composer.json file in your project root:, _(*6)

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

Install via composer, _(*7)

php composer.phar install

Usage

Below u find a list with available methods., _(*8)

GetWineByAvin

Gets a wine by Avin., _(*9)

use Websoftwares\AvinClient, Websoftwares\Avin;

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

GetWinesByName

Gets wine by name., _(*10)

use Websoftwares\AvinClient, Websoftwares\Avin;

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

GetCountries

Gets a list of countries., _(*11)

use Websoftwares\AvinClient, Websoftwares\Avin;

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

GetWineTypes

Gets a list of wine types., _(*12)

use Websoftwares\AvinClient, Websoftwares\Avin;

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

GetProducerByID

Gets a producer by id., _(*13)

use Websoftwares\AvinClient, Websoftwares\Avin;

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

GetProducerByName

Gets a producer by name., _(*14)

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., _(*15)

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., _(*16)

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., _(*17)