PHP Classes

PHP Busca CEP Correios: API to search for Brazilian zip codes

Recommend this page to a friend!
     
  Info   Example   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not enough user ratingsTotal: 81 All time: 10,102 This week: 67Up
Version License PHP version Categories
busca_cep 1.0.0MIT/X Consortium ...5PHP 5, Web services, Geography
Description 

Author

Thiago Przyczynski
This package is specific mainly for applications used in Brazil Brazil .

This package provides an API to search for Brazilian zip codes.

It provides an API that can perform searches for zip codes in Brazil based on the city or state, or get the location associated to a given zip code.

In Portuguese:

Este componente pode realizar pesquisas de CEP usando uma API desenvolvida com Lumen.

Ele fornece uma API que pode realizar pesquisas por códigos postais no Brasil com base na cidade ou estado ou obter o local associado a um determinado CEP.

Innovation Award
PHP Programming Innovation award nominee
June 2019
Number 4

Prize: 1 Year Subscription to NomadPHP Advanced PHP Learning		 Correios is a postal service company that delivers postal mail and parcels sent or received in Brazil.

This package provides an API that can be called by applications to inquire about information of interest to be used when sending postal mail or shipping parcels using the Correios service like zip codes of cities or addresses associated to a zip code.

Manuel Lemos
Picture of Thiago Przyczynski
  Performance   Level  

Level 3 StarStarStar

 Innovation award
Innovation award
Nominee: 8x

 

Example

<?php

/*
|--------------------------------------------------------------------------
| Application Routes
|--------------------------------------------------------------------------
|
| Here is where you can register all of the routes for an application.
| It is a breeze. Simply tell Lumen the URIs it should respond to
| and give it the Closure to call when that URI is requested.
|
*/
$app->get('/', function () use ($app) {
    return 'Muito obrigado por utilizar este software. Para mais informações acesse: <a href="https://github.com/thiagoprz/busca_cep">https://github.com/thiagoprz/busca_cep</a>';
});
$app->group(['prefix' => 'api/v1'], function($app) {
    $app->get('/', 'CepController@index');
    $app->get('cidade/{cep}', 'CepController@cidade');
    $app->get('estado/{cep}', 'CepController@estado');
    $app->get('cep/{cep}', 'CepController@cep');
});

Details

Busca CEP

Projeto com o fim de disponibilizar informações de CEP sobre logradouros e cidades em uma api simplificada. Framework utilizado:Lumen*

Banco de Dados

O banco de dados atualmente é formado por 3 entidades, sendo elas: estado, cidade e cep.

Endpoints da API

Estado

Para pesquisa de CEP por estado está disponível o método api/v1/estado/{cep}, onde {cep} é o número de CEP a ser pesquisado. Podendo ser no formato 99.999-99, 99999-99 ou 9999999.

Cidade

Para pesquisa de CEP por cidade está disponível o método api/v1/cidade/{cep}, onde {cep} é o número de CEP a ser pesquisado. Podendo ser no formato 99.999-99, 99999-99 ou 9999999.

CEP (Logradouro)

Para pesquisa de CEP por logradouro está disponível o método api/v1/cep/{cep}, onde {cep} é o número de CEP a ser pesquisado. Podendo ser no formato 99.999-99, 99999-99 ou 9999999.

Instalação

Para instalar basta configurar o ambiente criando o arquivo .env com base no arquivo .env.example e rodar composer install para instalar as dependências e php artisan migrate para que o banco de dados seja montado com as tabelas necessárias.

Requisitos

  • PHP >= 5.6.4
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension

Dados de demonstração

No seguinte link é possível baixar um arquivo SQL com os inserts de dados para testar o uso da API, nele estão contidos ceps de todos os estados e cidades que consegui obter. Dados de Exemplo.sql

Licença

Licenciado sobre a licença MIT license


  Files folder image Files (43)  
File Role Description
Files folder imageapp (2 files, 8 directories)
Files folder imagebootstrap (1 file)
Files folder imagedatabase (3 directories)
Files folder imagepublic (2 files)
Files folder imageroutes (1 file)
Files folder imagetests (2 files)
Accessible without login Plain text file .env.example Data Auxiliary data
Accessible without login Plain text file artisan Example Example script
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file Procfile Data Auxiliary data
Accessible without login Plain text file readme.md Doc. Documentation

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
Downloadbusca_cep-2019-06-27.zip 38KB
Downloadbusca_cep-2019-06-27.tar.gz 27KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:81
This week:0
All time:10,102
This week:67Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.