jotapeluiz/apicep

Api for integration to the site https://apicep.com/api-de-consulta/ to search for addresses through zip code


Keywords
api, address, search, zipcode, integration, cep, php-library, php7
License
MIT

Documentation

APICEP

Classe que busca um endereƧo no site https://apicep.com/api-de-consulta/ a partir do CEP.

InstalaĆ§Ć£o

composer require jotapeluiz/apicep

Modo de usar

require_once '/vendor/autoload.php';

use WideNet\ZipCode;

$zipCode = new ZipCode('06233030');

if ($zipCode->found()) {
    echo $zipCode->code;        // CEP
    echo $zipCode->state;       // Estado (sigla)
    echo $zipCode->stateName;   // Estado
    echo $zipCode->city;        // Cidade
    echo $zipCode->district;    // Bairro
    echo $zipCode->address;     // Rua
}

// endereƧo no formato de array
$zipCode->toArray();

// endereƧo no formato json
$zipCode->toJson();

Acesse o arquivo example/example.php para ver mais modo de uso.

Desenvolvimento

RecomendƔvel usar Docker.

Buildando a imagem:

docker-compose build api-cep

Instalando as dependĆŖncias:

docker-compose run --rm api-cep composer install

Rodando os testes:

Acesse o terminal do container:

docker-compose run --rm api-cep sh

Execute os testes:

./vendor/bin/phpunit tests --testdox --colors