PHPackages                             canducci/cep - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. canducci/cep

ActiveLibrary[Utility & Helpers](/categories/utility)

canducci/cep
============

CEP do Brasil Web Service ViaCep (https://viacep.com.br)

v3.1.2(1y ago)20266.6k↑29.4%2[1 PRs](https://github.com/netdragoon/canduccicep/pulls)MITPHPPHP >=8.3.2CI failing

Since Oct 17Pushed 5mo agoCompare

[ Source](https://github.com/netdragoon/canduccicep)[ Packagist](https://packagist.org/packages/canducci/cep)[ RSS](/packages/canducci-cep/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (3)Versions (17)Used By (0)

Canducci Cep
============

[](#canducci-cep)

CEP do Brazil - Web Service [https://www.viacep.com.br](viacep.com.br)

[![Version](https://camo.githubusercontent.com/e9f3bf5e7f891413810ae016c5985b02bfb9caaae82b0e2cd5b49f1851dad523/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f63616e64756363692f6365702e7376673f6c6162656c3d76657273696f6e)](https://packagist.org/packages/canducci/cep)[![Downloads](https://camo.githubusercontent.com/10a447932cab4dfc0fc9282ab1f984ed46deb967ada9d60bb9cdd7e344e2d85e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f63616e64756363692f6365702e7376673f7374796c653d666c6174)](https://packagist.org/packages/canducci/cep)[![PHP Composer](https://github.com/netdragoon/canduccicep/workflows/PHP%20Composer/badge.svg)](https://packagist.org/packages/canducci/cep)[![License](https://camo.githubusercontent.com/79bd0070eb2703e0578bbe22d0e6ba856d08275645cc9e16da7bc4f757d357d3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f63616e64756363692f6365702e737667)](https://packagist.org/packages/canducci/cep)

[Versão de configuração V2 - clique aqui](https://github.com/netdragoon/canduccicep/blob/master/READMEv2.md)

Instalação do Pacote
--------------------

[](#instalação-do-pacote)

```
composer require canducci/cep
```

Configuração
------------

[](#configuração)

###### 1) Laravel

[](#1-laravel)

Se você utiliza o `Framework` [Laravel](https://www.laravel.com) segue logo abaixo as confgurações após a instalação.

1. Entre na pasta `app/config` no arquivo `app.php`.
2. No arquivo procure o `array` `providers`
3. Entre com o `provider` no final da lista como exemplo:

    ```
    'providers' => [
        ...
        Canducci\Cep\Providers\CepServiceProvider::class
    ]
    ```
4. Dentro do mesmo arquivo (`app.php`) configure os apelidos (`Facades`) como exemplo:

    ```
    'aliases' => [
        ...
        'Cep' => Canducci\Cep\Facades\Cep::class,
        'Endereco' => Canducci\Cep\Facades\Endereco::class
    ]
    ```
5. Como utilizar?

    5.1 Com Injeção de Dependencia:

    ```
    Route::get('/cep', function(\Canducci\Cep\Cep $cep){
        $cepResponse = $cep->find('01010000');
        $data = $cepResponse->getCepModel();
        return response()->json($data);
    });

    Route::get('/endereco', function(\Canducci\Cep\Endereco $endereco){
        $enderecoResponse = $endereco->find('sp','são paulo', 'ave');
        $data = $enderecoResponse->getCepModels();
        return response()->json($data);
    });
    ```

    5.2 Com Facade Laravel:

    ```
    Route::get('/cep', function(){
       $cepResponse = \Canducci\Cep\Facades\Cep::find('01010000');
       $data = $cepResponse->getCepModel();
       return response()->json($data);
    });

    Route::get('/endereco', function(){
       $enderecoResponse = \Canducci\Cep\Facades\Endereco::find('sp','são paulo', 'ave');
       $data = $enderecoResponse->getCepModels();
       return response()->json($data);
    });
    ```

    5.3 Com `function` (função)

    ```
    Route::get('/cep', function(){
       $cepResponse = cep('01010000');
       $data = $cepResponse->getCepModel();
       return response()->json($data);
    });

    Route::get('/endereco', function(){
        $enderecoResponse = endereco('sp','são paulo','ave');
        $data = $enderecoResponse->getCepModels();
        return response()->json($data);
     });
    ```
6. Resposta satisfatória:

    6.1 - Utilize o método `isOk()` para verificar se realmente os dados foram recebidos:

    ```
    $cepResponse = cep('01010000');
    if ($cepResponse->isOk())
    {
        $data = $cepResponse->getCepModel();
        return response()->json($data);
    }
    ```

    e os dados são recuperados pelos metodos ou propriedades, exemplo:

    ```
     $model->getCep() ou $model->cep
     $model->getLogradouro() ou $model->logradouro
     $model->getComplemento() ou $model->c omplemento
     $model->getBairro() ou $model->bairro
     $model->getLocalidade() ou $m odel->localidade
     $model->getUf() ou $model->uf
     $model->getDdd() ou $model->ddd
     $model->getSiafi() ou $model->siafi
     $model->getIbge() ou $model->ibge
     $model->getGia() ou $model->gia
     $model->getUnidade() ou $model->unidade
     $model->getEstado() ou $model->estado
     $model->getRegiao() ou $model->regiao
    ```

    6.2 - Dados informados errados

    6.2.1 - No `Cep` o valor informado deve possuir um desses formatos:

    - 01010000, ou
    - 01010-000

    para uma resposta satisfatória, se não um exceção será lançada.

    6.2.2 - No `Endereco` os valores informados segue essas regras

    - Uf com 2 letras
    - Cidade com no minimo 3 letras
    - Logradouro com no minimo 3 letras

    se não uma exceção será lançada.

###### 2) Qualquer código que usa o composer.phar:

[](#2-qualquer-código-que-usa-o-composerphar)

```
λ php composer.phar require canducci/cep

```

logo após isso, inclua no seu código o `autoload.php` que está dentro da pasta `vendor`, exemplo:

```