README.md

CEP Grátis

Com esse pacote você poderá realizar consultas de CEP gratuitamente.

Para evitar problemas com indisponibilidade de serviços, a consulta é realizada paralelamente em providers diferentes:

• Correios
• Viacep
• CEP Aberto
• Api CEP (Antigo Widenet)
• Republica Virtual

A library irá retornar para você a resposta mais rápida, aumentando assim a performance da consulta.

Como utilizar

Adicione a library

$ composer require Prhost/cep-gratis

Adicione o autoload.php do composer no seu arquivo PHP.

require_once 'vendor/autoload.php';  

Agora basta chamar o método CepGratis::search($cep)

use Prhost\CepGratis\CepGratis;

$address = CepGratis::search('31030080'); 

Um exemplo passando opções como o token do CEP Aberto

use Prhost\CepGratis\CepGratis;

$cep = '31030080';
$options = ['token' => '123abc'];
$timeout = 15; //segundos

$address = CepGratis::search($cep, $options, $timeout); 

Outras formas:

use Prhost\CepGratis\CepGratis;
use Prhost\CepGratis\Providers\CepAbertoProvider;

$cepGratis = new CepGratis();
$cepGratis->setOptions(['token' => '123abc']);
$cepGratis->addProvider(new CepAbertoProvider());
$cepGratis->setTimeout(15);
$address = $cepGratis->resolve('31030080'); 

License

The MIT License (MIT)