API de Consulta

Use jQuery ou outros métodos para implementar a busca de endereços atualizados por cep diretamente no seu sistema de cadastro.

Siga-nos nas redes sociais e receba novidades  

Integrar API pra busca de CEP

Os desenvolvedores que possuem cadastros de endereços dos seus clientes, e querem integrar o auto-preenchimento do endereço baseado no CEP, podem utilizar a nossa API de consulta dinâmica. Nossa API trabalha com um método simples e bem funcional para atender todas as necessidades de consulta. Basicamente a API retorna resultados no formato JSON, que pode ser interpretado por qualquer plataforma. Entretanto existem alternativas para plataforma web com formato mais simples, não havendo a necessidade de utilizar um framework como jQuery.

URL da API de consulta

Segue os padrões das URLs da API de consulta para buscar o endereço, cidade e estado através do CEP.
No padrão abaixo constam os padrões diferentes e os exemplos dos mesmos, onde mostraremos o padrão absoluto e o padrão relativo da URL.

Nome do PadrãoPadrão / Exemplo
URL Absoluta http://apps.widenet.com.br/busca-cep/api/cep/<cepCode>.<format>
http://apps.widenet.com.br/busca-cep/api/cep/06233-030.json
URL Relativa http://apps.widenet.com.br/busca-cep/api/cep.<format>?code=<cepCode>
http://apps.widenet.com.br/busca-cep/api/cep.json?code=06233-030

 

Definição dos parâmetros que compõem a URL

ParâmetroDescriçãoExemplos / Opções
format Formato do retorno da consulta. json, js, xml, str
cepCode CEP a ser consultado, do qual irá corresponder ao endereço. Ex: 06233-030

 

Exemplos de respostas para cada formato

NomeFormatoExemplo de resposta
JSON json {"status":1,
  "code":"06233-030",
  "state":"SP",
  "city":"Osasco",
  "district":"Piratininga",
  "address":"Rua Paula Rodrigues"}
JavaScript js define_cep_info({
   "status":1,
   "code":"06233-030",
   "state":"SP",
   "city":"Osasco",
   "district":"Piratininga",
   "address":"Rua Paula Rodrigues"
});
XML xml <cep>
   <status>1</status>
   <code>06233-030</code>
   <state>SP</state>
   <city>Osasco</city>
   <district>Piratininga</district>
   <address>Rua Paula Rodrigues</address>
</cep>
QueryString str status=1&code=06233-030&state=SP&city=Osasco
&district=Piratininga&address=Rua+Paula+Rodrigues

 

Exemplo de consulta JSON usando jQuery

Nesse exemplo está aplicado em uma plataforma web, usando o framework jQuery. Nesse exemplo, o script identifica que o campo de CEP foi alterado e envia a requisição HTTP para a API com método GET, passando o CEP informado pelo usuário.

Código do exemplo

<form action="checkout-sample" method="POST">
CEP <input type="text" name="cep" id="cep" />
Estado <input type="text" name="estado" id="estado" />
Cidade <input type="text" name="cidade" id="cidade" />
Bairro <input type="text" name="bairro" id="bairro" />
Endereço <input type="text" name="endereco" id="endereco" />
</form>

<script type="text/javascript">
jQuery(function($){
$("#cep").change(function(){
var cep_code = $(this).val();
if( cep_code.length <= 0 ) return;
$.get("http://apps.widenet.com.br/busca-cep/api/cep.json", { code: cep_code },
function(result){
if( result.status!=1 ){
alert(result.message || "Houve um erro desconhecido");
return;
}
$("input#cep").val( result.code );
$("input#estado").val( result.state );
$("input#cidade").val( result.city );
$("input#bairro").val( result.district );
$("input#endereco").val( result.address );
$("input#estado").val( result.state );
});
});
});
</script>