Conheça as melhorias da versão 8.0, 8.1, 8.2!
Clique aqui para saber mais
Conheça Características Quem usa Galeria Cursos Docs Fórum
Downloads
Posts Fique por dentro Sobre o Fórum Minha conta
Webservice client para buscar CEP Segue uma classe cliente de webservice REST para consultar os dados do endereço, informando o CEP. No Adianti Template, lembrem-se de alterar o nome do arquivo rest.php.dist para rest.php Vocês podem utilizar esta funcionalidade incluindo no Form a função abaixo: ...
RC
Webservice client para buscar CEP  
Ricardo Câmara 27/03/2019 (há 6 anos)
Segue uma classe cliente de webservice REST para consultar os dados do endereço, informando o CEP.

No Adianti Template, lembrem-se de alterar o nome do arquivo rest.php.dist para rest.php

Vocês podem utilizar esta funcionalidade incluindo no Form a função abaixo: 

 
  1. <?php
  3. public static function onBuscarCep($param = null) 
  4.     {
  5.         try 
  6.         {
  7.             $endereco = ConsultaCepService::getCep($param['cep'], 'json');
  8.             if( isset($endereco->erro) )
  9.             {
  10.                 throw new Exception($endereco->mensagem);
  11.             }
  12.             else
  13.             {                
  14.                 //prepara stdClass para preencher o formulario com o endereco retornado
  15.                 $object                     = new stdClass();
  16.                 $object->uf                 = $endereco->uf;
  17.                 $object->cidade             = $endereco->localidade;
  18.                 $object->bairro             = $endereco->bairro;
  19.                 $object->logradouro          = $endereco->logradouro;
  20.                 $object->complemento     = $endereco->complemento;
  21.                 $object->numero             = $endereco->unidade;
  22.                 
  23.                 //envia os dados para o formulario
  24.                 TForm::sendData(self::$formName, $object);                            
  25.             }
  26.         }
  27.         catch (Exception $e) 
  28.         {
  29.             new TMessage('error', $e->getMessage());    
  30.         }
  31.     }
  32. ?>



Agora que vocês já podem chamar este serviço, segue a classe client webservice.
Sugiro salvá-la na pasta app/service 

 
  1. <?php
  3. /**
  4.  * ConsultaCepService
  5.  *
  6.  * webservice cliente para buscar os dados do CEP, fornecidos pelo site www.viacep.com.br
  7.  * @package service
  8.  * @author Ricardo Câmara (camaramachado@gmail.com)
  9.  * @version 1.0
  10.  */
  11.  
  12. class ConsultaCepService
  13. {
  14.     
  15.     /**
  16.      * Method getCep
  17.      * Consulta o CEP utilizando o webservice do site www.viacep.com.br
  18.      * @param $cep string - CEP a ser consultado
  19.      * @param $formato string - formato da resposta. Suportados json, xml, piped ou querty.
  20.      * @return stdClass, XML, string (depende do formato) com os dados do CEP
  21.      * Se o CEP não possuir 8 digitos ou não existir, $stdClass->erro retorna TRUE e $stdClass->mensagem informa o erro.
  22.      * Exemplo de uso: $endereco = ConsultaCepService::getCep('99999999');
  23.      */
  24.     public static function getCep($cep, $formato = 'json')
  25.     {
  26.         try
  27.         {                                        
  28.             if( isset($cep) )
  29.             {
  30.                 //valida os formatos
  31.                 $formatos = ['json', 'xml', 'piped', 'querty'];
  32.                 if( !in_array($formato, $formatos) )
  33.                 {
  34.                     $retorno             = new stdClass;
  35.                     $retorno->erro         = TRUE;
  36.                     $retorno->mensagem     = "Formato <b>{$formato}</b> não suportado!";
  37.                     return $retorno;
  38.                 }
  39.                 
  40.                 //pega apenas os numeros, retirando os demais caracteres
  41.                 $cep = preg_replace("/[^0-9]/", "", $cep);
  42.                 
  43.                 //o CEP deve ter 8 digitos
  44.                 if( strlen($cep) != 8 )
  45.                 {
  46.                     $retorno             = new stdClass;
  47.                     $retorno->erro         = TRUE;
  48.                     $retorno->mensagem     = "CEP: <b>{$cep}</b> não possui 8 digitos!";    
  49.                     return $retorno;                                    
  50.                 }
  51.                 
  52.                 switch($formato)
  53.                 {
  54.                     case 'json':                        
  55.                         $retorno = json_decode( file_get_contents("https://viacep.com.br/ws/{$cep}/{$formato}") );
  56.                         break;
  57.                         
  58.                     case 'xml':                        
  59.                         $retorno = htmlentities(file_get_contents("https://viacep.com.br/ws/{$cep}/{$formato}"));
  60.                         break;
  61.                 
  62.                     case 'piped':                        
  63.                         $retorno = file_get_contents("https://viacep.com.br/ws/{$cep}/{$formato}");
  64.                         break;
  65.                 
  66.                     case 'querty':                        
  67.                         $retorno = file_get_contents("https://viacep.com.br/ws/{$cep}/{$formato}");
  68.                         break;
  69.                 }
  70.                                                                                            
  71.                 //checa se o cep não existe, neste caso o atributo erro será TRUE
  72.                 if( isset($retorno->erro) )
  73.                 {
  74.                     $retorno->mensagem = "CEP: <b>{$cep}</b> não existe na base de dados!";
  75.                 }
  76.                 
  77.                 return $retorno;
  78.             }
  79.         }
  80.         catch (Exception $e)
  81.         {
  82.             echo 'Error: ' . $e->getMessage();
  83.         }
  84.     }
  85.     
  86. }
  89. /*
  90. *******************  FORMATO JSON  *******************  
  92. Retorno quando o CEP existe:
  93. stdClass Object
  94. (
  95.     [cep] => 51111-000
  96.     [logradouro] => Avenida Boa Viagem
  97.     [complemento] => de 1382/1383 a 2173/2174
  98.     [bairro] => Boa Viagem
  99.     [localidade] => Recife
  100.     [uf] => PE
  101.     [unidade] => 
  102.     [ibge] => 2611606
  103.     [gia] => 
  104. )
  106. Retorno quando o CEP não tem 8 digitos:
  107. stdClass Object
  108. (
  109.     [erro] => 1
  110.     [mensagem] => CEP: 5111100 não existe na base de dados!
  111. )
  113. Retorno quando o CEP não existe:
  114. stdClass Object
  115. (
  116.     [erro] => 1
  117.     [mensagem] => CEP: 99999999 não existe na base de dados!
  118. )
  120. Retorno se o formato não for suportado
  121. stdClass Object
  122. (
  123.     [erro] => 1
  124.     [mensagem] => Formato java não suportado!
  125. )
  126. */
  128. /*
  129. *******************  FORMATO XML  *******************  
  131. Retorno quando o CEP existe:
  132. <?xml version="1.0" encoding="UTF-8"?>

<xmlcep>
<cep>04822-000</cep>
<logradouro>Rua Jequirituba</logradouro>
<complemento>de 1091/1092 a 1998/1999</complemento>
<bairro>Parque América</bairro>
<localidade>São Paulo</localidade>
<uf>SP</uf>
<unidade></unidade>
<ibge>3550308</ibge>
<gia>1004</gia>
</xmlcep>
*/

/*
******************* FORMATO PIPED *******************

Retorno quando o CEP existe:
cep:51111-000|logradouro:Avenida Boa Viagem|complemento:de 1382/1383 a 2173/2174|bairro:Boa Viagem|localidade:Recife|uf:PE|unidade:|ibge:2611606|gia:
*/

/*
******************* FORMATO QUERTY *******************

Retorno quando o CEP existe:
cep=51111-000&logradouro=Avenida+Boa+Viagem&complemento=de+1382%2F1383+a+2173%2F2174&bairro=Boa+Viagem&localidade=Recife&uf=PE&unidade=&ibge=2611606&gia=
*/

?>

Curso Dominando o Adianti Framework

O material mais completo de treinamento do Framework.
Curso em vídeo aulas + Livro completo + Códigos fontes do projeto ERPHouse.
Conteúdo Atualizado!


Dominando o Adianti Framework Quero me inscrever agora!

Comentários (7)

F
3F-TI       15/08/2019 (há 6 anos)

Boa tarde Ricardo!
Era justamente o que tava procurando... você pode por favor exemplificar um caso de uso em um formulário de cadastro por exemplo.... como deveria ser chamado! Sou novo e estou aprendendo... será de grande valia!
Parabenizo pelo conteúdo compartilhado e conto com seu apoio.
Antecipadamente agradeço.
F
3F-TI       16/08/2019 (há 6 anos)

Bom dia Ricardo!
Quebrando a cabeça aqui consegui fazer uso.
Não sei porque mas só funcionou depois de alterado a linha "TForm::sendData(self::$formName, $object);" removendo o parametro "self::$formName" e deixando só o nome do formulário, ficando assim TForm::sendData('<nome do formulario'>, $object);
Muito obrigado por compartilhar.</nome>
FA
Fabricio Almeida       20/07/2020 (há 5 anos)

Boa tarde Galera. Não estou conseguindo utilizar o código em meu projeto.
Fiz tudo certinho como no tutorial. Mas, quando coloco para pesquisar um cep. ele me retorna os seguintes erros. "Warning: file_get_contents(): SSL operation failed with code 1. OpenSSL Error messages:
error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed in /var/www/bkcraft/app/service/ConsultaCepService.php on line 54



Warning: file_get_contents(): Failed to enable crypto in /var/www/bkcraft/app/service/ConsultaCepService.php on line 54



Warning: file_get_contents(https://viacep.com.br/ws/78015245/json): failed to open stream: operation failed in /var/www/bkcraft/app/service/ConsultaCepService.php on line 54"
(LINK DA IMAGEM ABAIXO)
https://imgur.com/a/PEu17lu
RC
Ricardo Câmara - AUTOR DO POST       21/07/2020 (há 5 anos)

Oi Fabrício Almeida,
também passei por este problema, para corrigir a classe ConsultaCepService por esta: 


 
  1. <?php
  3. /**
  4.  * ConsultaCepService
  5.  *
  6.  * webservice cliente para buscar os dados do CEP, fornecidos pelo site www.viacep.com.br
  7.  * @package service
  8.  * @author Ricardo Câmara (camaramachado@gmail.com)
  9.  * @version 1.0
  10.  */
  11. class ConsultaCepService
  12. {
  13.     /**
  14.      * Method getCep
  15.      * Consulta o CEP utilizando o webservice do site www.viacep.com.br
  16.      * @param $cep string - CEP a ser consultado
  17.      * @param $formato string - formato da resposta. Suportados json, xml, piped ou querty.
  18.      * @return stdClass, XML, string (depende do formato) com os dados do CEP
  19.      * Se o CEP não possuir 8 digitos ou não existir, $stdClass->erro retorna TRUE e $stdClass->mensagem informa o erro.
  20.      * Exemplo de uso: $endereco = ConsultaCepService::getCep('99999999');
  21.      */
  22.     public static function getCep($cep, $formato = 'json')
  23.     {
  24.         session_write_close();
  25.         
  26.         try
  27.         {                                        
  28.             if( isset($cep) )
  29.             {
  30.                 //valida os formatos
  31.                 $formatos = ['json', 'xml', 'piped', 'querty'];
  32.                 if( !in_array($formato, $formatos) )
  33.                 {
  34.                     $retorno             = new stdClass;
  35.                     $retorno->erro         = TRUE;
  36.                     $retorno->mensagem     = "Formato <b>{$formato}</b> não suportado!";
  37.                     return $retorno;
  38.                 }
  39.                 
  40.                 //pega apenas os numeros, retirando os demais caracteres
  41.                 $cep = preg_replace("/[^0-9]/", "", $cep);
  42.                 
  43.                 //o CEP deve ter 8 digitos
  44.                 if( strlen($cep) != 8 )
  45.                 {
  46.                     $retorno             = new stdClass;
  47.                     $retorno->erro         = TRUE;
  48.                     $retorno->mensagem     = "CEP: <b>{$cep}</b> não possui 8 digitos!";    
  49.                     return $retorno;                                    
  50.                 }
  51.    
  52.                 switch($formato)
  53.                 {
  54.                     case 'json':
  55.                         $retorno = json_decode( file_get_contents("http://viacep.com.br/ws/{$cep}/json/") ); 
  56.                         break;
  57.                         
  58.                     case 'xml':                        
  59.                         $retorno = htmlentities(file_get_contents("http://viacep.com.br/ws/{$cep}/xml/"));
  60.                         break;
  61.                 
  62.                     case 'piped':                        
  63.                         $retorno = file_get_contents("http://viacep.com.br/ws/{$cep}/piped/");
  64.                         break;
  65.                 
  66.                     case 'querty':                        
  67.                         $retorno = file_get_contents("http://viacep.com.br/ws/{$cep}/querty/");
  68.                         break;
  69.                 }
  70.                                                                                            
  71.                 //checa se o cep não existe, neste caso o atributo erro será TRUE
  72.                 if( isset($retorno->erro) )
  73.                 {
  74.                     $retorno->mensagem = "CEP: <b>{$cep}</b> não existe na base de dados!";
  75.                 }
  76.                 
  77.                 return $retorno;
  78.             }
  79.         }
  80.         catch (Exception $e)
  81.         {
  82.             echo 'Error: ' . $e->getMessage();
  83.         }
  84.     }
  85.     
  86. }
  90. /*
  91. *******************  FORMATO JSON  *******************  
  93. Retorno quando o CEP existe:
  94. stdClass Object
  95. (
  96.     [cep] => 51111-000
  97.     [logradouro] => Avenida Boa Viagem
  98.     [complemento] => de 1382/1383 a 2173/2174
  99.     [bairro] => Boa Viagem
  100.     [localidade] => Recife
  101.     [uf] => PE
  102.     [unidade] => 
  103.     [ibge] => 2611606
  104.     [gia] => 
  105. )
  107. Retorno quando o CEP não tem 8 digitos:
  108. stdClass Object
  109. (
  110.     [erro] => 1
  111.     [mensagem] => CEP: 5111100 não existe na base de dados!
  112. )
  114. Retorno quando o CEP não existe:
  115. stdClass Object
  116. (
  117.     [erro] => 1
  118.     [mensagem] => CEP: 99999999 não existe na base de dados!
  119. )
  121. Retorno se o formato não for suportado
  122. stdClass Object
  123. (
  124.     [erro] => 1
  125.     [mensagem] => Formato java não suportado!
  126. )
  127. */
  129. /*
  130. *******************  FORMATO XML  *******************  
  132. Retorno quando o CEP existe:
  133. <?xml version="1.0" encoding="UTF-8"?>

<xmlcep>
<cep>04822-000</cep>
<logradouro>Rua Jequirituba</logradouro>
<complemento>de 1091/1092 a 1998/1999</complemento>
<bairro>Parque América</bairro>
<localidade>São Paulo</localidade>
<uf>SP</uf>
<unidade></unidade>
<ibge>3550308</ibge>
<gia>1004</gia>
</xmlcep>
*/

/*
******************* FORMATO PIPED *******************

Retorno quando o CEP existe:
cep:51111-000|logradouro:Avenida Boa Viagem|complemento:de 1382/1383 a 2173/2174|bairro:Boa Viagem|localidade:Recife|uf:PE|unidade:|ibge:2611606|gia:
*/


FA
Fabricio Almeida       21/07/2020 (há 5 anos)

Oi Ricardo Câmara,
Muito obrigado!
AV
Amaury Vieira       11/12/2020 (há 4 anos)

Bom dia, pessoal, sou novo no adianti, estou procurando entender a ferramenta, alguém teria um modelo de formulário com esta rotina do cep para poder disponibilizar para que eu possa entender a mecnica do mesmo.

Fico agradecido caso seja atendido.

Amaury
AV
Adalberto Lima Vitorino       05/05/2021 (há 4 anos)

Valeu pela contribuição Ricardo, ajudou bem.