Como buscar um CEP ou nome de rua em PHP

Introdução

Na era digital, informações precisas sobre CEPs e endereços são essenciais. A MCO2 disponibiliza um componente PHP exclusivo para sites hospedados em sua plataforma, facilitando a busca desses dados. Este guia rápido mostra como usá-lo.

Código Pronto para Uso

Segue abaixo dois exemplos práticos de implementação com nosso componente de CEP. Eles abrangem as funcionalidades de busca por CEP e por logradouro.

Busca por CEP

require_once 'InternetBrasil/CorreiosCEP.php';
$CEP = new \InternetBrasil\CorreiosCEP();

$CEP->EncontraCEP('01310900');
if ($CEP->Status()) {
  echo "CEP: " . $CEP->CEP() . "<br />\n";
  echo "Endereco: " . $CEP->Endereco() . "<br />\n";
  echo "EnderecoAbrev: " . $CEP->EnderecoAbrev() . "<br />\n";
  echo "Usuario: " . $CEP->Usuario() . "<br />\n";
  echo "TipoLogradouro: " . $CEP->TipoLogradouro() . "<br />\n";
  echo "TipoLogradouroAbrev: " . $CEP->TipoLogradouroAbrev() . "<br />\n";
  echo "Logradouro: " . $CEP->Logradouro() . "<br />\n";
  echo "LogradouroAbrev: " . $CEP->LogradouroAbrev() . "<br />\n";
  echo "Localidade: " . $CEP->Localidade() . "<br />\n";
  echo "Cidade: " . $CEP->Cidade() . "<br />\n";
  echo "Bairro: " . $CEP->Bairro() . "<br />\n";
  echo "Bairro1: " . $CEP->Bairro1() . "<br />\n";
  echo "Bairro2: " . $CEP->Bairro2() . "<br />\n";
  echo "BairroAbrev: " . $CEP->BairroAbrev() . "<br />\n";
  echo "Bairro1Abrev: " . $CEP->Bairro1Abrev() . "<br />\n";
  echo "Bairro2Abrev: " . $CEP->Bairro2Abrev() . "<br />\n";
  echo "Estado: " . $CEP->Estado() . "<br />\n";
} else {
  echo "ERRO: " . $CEP->Mensagem() . "<br />\n";
}

Busca por Logradouro

require_once 'InternetBrasil/CorreiosCEP.php';
$CEP = new \InternetBrasil\CorreiosCEP();

$CEP->EncontraEndereco('SP', 'São Paulo', 'Paulista');
if ($CEP->Status()) {
  echo "<p>Logradouros encontrados:</p>";
  echo "<table><thead>";
  echo "<tr><th>Endereço</th><th>CEP</th><th>Bairro</th></tr>";
  echo "</thead><tbody>";
  foreach ($CEP->Logradouros() as $aLogradouro) {
    echo "<tr><td>" . $aLogradouro["Endereco"] . "</td>";
    echo "<td>" . $aLogradouro["CEP"] . "</td>";
    echo "<td>" . $aLogradouro["Bairro"] . "</td></tr>";
  }
  echo "</tbody></table>";
} else {
  echo "ERRO: " . $CEP->Mensagem() . "<br />\n";
}

Explicando o Código

Agora, vamos entender cada trecho dos exemplos de código fornecidos anteriormente.

Busca por CEP

Inclusão do componente: O código começa com a inclusão do componente de CEP, fundamental para acessar as funcionalidades oferecidas pela biblioteca InternetBrasil.

require_once 'InternetBrasil/CorreiosCEP.php';

Instanciação do objeto CEP: Aqui, um objeto $CEP é criado a partir da classe \InternetBrasil\CorreiosCEP. Esse objeto é quem realizará a busca do CEP.

$CEP = new \InternetBrasil\CorreiosCEP();

Executando a busca: A função EncontraCEP() é chamada com um CEP específico, iniciando a busca pelos detalhes desse CEP.

$CEP->EncontraCEP('01310900');

Verificação de sucesso: Verifica se a busca foi bem-sucedida. Se sim, exibe as informações do CEP. Caso contrário, mostra uma mensagem de erro.

if ($CEP->Status()) {
  // Exibe informações do CEP
} else {
  echo "ERRO: " . $CEP->Mensagem() . "<br />\n";
}

Busca por Logradouro

A busca por logradouro permite localizar endereços específicos a partir de informações como estado, cidade e o próprio logradouro. Veja como é simples:

Inclusão do componente e instanciação do objeto: Primeiramente, incluímos o componente necessário e criamos uma instância da classe \InternetBrasil\CorreiosCEP, semelhante ao processo de busca por CEP.

require_once 'InternetBrasil/CorreiosCEP.php';
$CEP = new \InternetBrasil\CorreiosCEP();

Executando a busca por logradouro: Com o objeto $CEP pronto, utilizamos o método EncontraEndereco() para buscar endereços. Diferentemente da busca por CEP, essa função requer três argumentos: o estado, a cidade e o nome do logradouro. Isso permite uma pesquisa mais específica.

$CEP->EncontraEndereco('SP', 'São Paulo', 'Paulista');

Exibição dos resultados: Após a busca, verificamos se ela foi bem-sucedida. Em caso positivo, iteramos pelos resultados e exibimos cada um em uma tabela HTML. Caso contrário, informamos ao usuário sobre o erro.

if ($CEP->Status()) {
  echo "<p>Logradouros encontrados:</p>";
  echo "<table><thead>";
  echo "<tr><th>Endereço</th><th>CEP</th><th>Bairro</th></tr>";
  echo "</thead><tbody>";
  foreach ($CEP->Logradouros() as $logradouro) {
    echo "<tr><td>" . $logradouro["Endereco"] . "</td>";
    echo "<td>" . $logradouro["CEP"] . "</td>";
    echo "<td>" . $logradouro["Bairro"] . "</td></tr>";
  }
  echo "</tbody></table>";
} else {
  echo "ERRO: " . $CEP->Mensagem() . "<br />\n";
}

Conclusão

Este artigo forneceu instruções detalhadas sobre como implementar funcionalidades de busca por CEP e por logradouro em projetos PHP, utilizando um componente exclusivo oferecido pela MCO2. Com os códigos e explicações apresentados, desenvolvedores podem enriquecer seus sites com recursos de busca rápida e precisa de informações de endereços, melhorando significativamente a experiência do usuário.

Importante ressaltar que o uso deste componente é exclusivo para clientes hospedados na MCO2, garantindo uma integração eficiente e segura. Essa exclusividade assegura o acesso direto às bases de dados de CEP, proporcionando uma vantagem competitiva significativa aos projetos hospedados na MCO2.

Se seu site não está hospedado na MCO2, transfira sua hospedagem para a MCO2 e tenha até 60 dias gratuitos de hospedagem.