adrianolaselva / fipeapi
Pacote de integração com APIs da Fipe
Requires
- php: >=5.6
- php-curl-class/php-curl-class: ^4.11
Requires (Dev)
- phpunit/phpunit: 5.2.12
README
[![version][packagist-badge]][packagist] [packagist-badge]: https://img.shields.io/packagist/v/adrianolaselva/fipeapi.svg [packagist]: https://packagist.org/packages/adrianolaselva/fipeapi
Pacote de integração com APIs da Fipe
Este Projeto tem por finalidade prover uma integração menos traumática e padronizada com as API's de consulta da Fipe
Dependências
require
- PHP >= 5.6
- php-curl-class/php-curl-class ^4.11
require-dev
- phpunit/phpunit 5.2.12
Instalação
Execute em seu shell:
composer require adrianolaselva/fipeapi
Descrição
Para passar parâmetros contendo configurações será necessário instânciar o Client e passar um array da seguinte forma.
$client = new \FipeApi\Client([ \FiapeApi\FipeApiParameter::FIPE_API_HOST => "http://fipeapi.appspot.com/api/1/", \FiapeApi\FipeApiParameter::FIPE_API_TIMEOUT => 20, ]);
Caso o parâmetro do construtor seja passado como nulo, as seguintes informações serão usadas como padrão.
'FIPE_API_HOST' = 'http://fipeapi.appspot.com/api/1/'
'FIPE_API_TIMEOUT' = 10
Para iniciar as consultas basta instânciar uma das classes presentes no pacote "Fipe\Api\*", passar a instância do Client como parâmetro no construtor ou deixar vazio para que seja acatado o padrão, ficando da seguinte forma:
$caminhaoApi = new \FipeApi\Api\Caminhao();
Ou
$caminhaoApi = new \FipeApi\Api\Caminhao($client);
Caso precise alterar os parâmetros após inicializado o client, basta fazer da seguinte forma:
$client = new \FipeApi\Client(); $client->setParameter(\FiapeApi\FipeApiParameter::FIPE_API_HOST, "http://fipeapi.appspot.com/api/1/"); $client->setParameter(\FiapeApi\FipeApiParameter::FIPE_API_TIMEOUT, 50); $caminhaoApi = new \FipeApi\Api\Caminhao($client);