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.

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:
Exemplo:
https://ws.apicep.com/cep/[cepCode].[format]
https://ws.apicep.com/cep/06233-030.json
URL Relativa:
Exemplo:
https://ws.apicep.com/cep.[format]?code=[cepCode]
https://ws.apicep.com/cep.json?code=06233-030

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

ParâmetroDescriçãoOpções / Exemplos
formatFormato do retorno da consulta.json, js, xml
cepCodeCEP a ser consultado, do qual irá corresponder ao endereço.Ex: 06233-030

Exemplos de respostas para cada formato

NomeFormatoExemplo de resposta
JSONjson
{"status":200,
 "code":"06233-030",
 "state":"SP",
 "city":"Osasco",
 "district":"Piratininga",
 "address":"Rua Paula Rodrigues"}
JavaScriptjs
define_cep_info({
 "status":200,
 "code":"06233-030",
 "state":"SP",
 "city":"Osasco",
 "district":"Piratininga",
 "address":"Rua Paula Rodrigues"
});
XMLxml
<xml>
 <status>200</status>
 <code>06233-030</code>
 <state>SP</state>
 <city>Osasco</city>
 <district>Piratininga</district>
 <address>Rua Paula Rodrigues</address>
</xml>

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. O resultado da consulta é definido em cada campo.

Para conferir outros exemplos de implementação da API de consulta de CEPs atualizados, incluindo scripts nativos sem jQuery, acesse nosso github com todos os códigos de exemplos.

Licença

Livre para uso comercial, exclusivamente para implementações de consulta sob demanda em páginas web, com execução a partir de navegadores, não incluindo consultas em massa ou leitura sequencial de CEPs. Não é autorizado o uso de servidores para intermediação das consultas.