 Especificação Técnica | Web Service de CEPs e Código IBGE |
| |
Chave para testes: Chave_Gratuita_BuscarCep
Esta chave permite 1 busca por minuto e deve ser utilizada somente para testes.
HTTPS/SSL: https://buscarcep.com.br/?cep=30010960&chave=Chave_Gratuita_BuscarCep
O buscar cep pode ser utilizado com https/ssl. |
|
#2 - Informando CEP
| Tipo |
Formato URL |
| string |
https://buscarcep.com.br/?cep=30010960&formato=string&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
| xml |
https://buscarcep.com.br/?cep=30010960&formato=xml&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
| json |
https://buscarcep.com.br/?cep=30010960&formato=json&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
- O valor em negrito (CEP), pode ser modificado;
- O CEP pode ser passado com ou sem o hífen;
- O parâmetro identificador pode ser usado para identificar a quantidade de buscas por cliente ou sistema.
|
|
Parametros para requisição do cep
| Nome |
Tamanho |
Tipo de dado |
Obrigatório? |
| cep |
9 |
varchar |
Sim. |
| formato |
6 |
enum: [xml, string] |
Opcional. Caso omitido, assume o formato xml. |
| chave |
100 |
varchar |
Sim. |
| identificador |
100 |
varchar |
Opcional. |
|
|
#3 - Informando Logradouro, Cidade, UF (Opcional) e Bairro (Opcional)
| Tipo |
Formato URL |
| string |
https://buscarcep.com.br/?tipo_logradouro=avenida&logradouro=afonso pena&uf=mg&cidade=belo horizonte&bairro=centro&formato=string&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
| xml |
https://buscarcep.com.br/?tipo_logradouro=avenida&logradouro=afonso pena&uf=mg&cidade=belo horizonte&bairro=centro&formato=xml&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
- O parametro tipo_logradouro, bairro e uf são opcionais;
- Cada resultado de Logradouro retornado é contado com uma busca, portante filtre suas buscas também pelo CEP;
- É retornado o máximo de 10 logradouros ordenados por ordem alfabética;
- O retorno do XML utiliza codificação padrão UTF-8.
|
|
Parametros para requisição do endereço
| Nome |
Tamanho |
Tipo de dado |
Obrigatório? |
| formato |
6 |
enum: [xml, string] |
Opcional. Caso omitido, assume o formato xml. |
| chave |
100 |
varchar |
Sim. |
| tipo_logradouro |
100 |
varchar |
Opcional. Ver lista de tipos. |
| logradouro |
100 |
varchar |
Sim. |
| uf |
2 |
char |
Opcional. |
| cidade |
100 |
varchar |
Sim. |
| bairro |
100 |
varchar |
Opcional. |
| identificador |
6 |
varchar |
Opcional. |
|
|
#4 - Informando Endereço
| Tipo |
Formato URL |
| string |
https://buscarcep.com.br/?endereco=augusto de lima belo horizonte&formato=string&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
| xml |
https://buscarcep.com.br/?endereco=augusto de lima belo horizonte&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1 |
- A ordem para montagem do endereço, para localização mais precisa é tipo logradouro + logradouro + bairro + cidade;
- Cada resultado de Logradouro retornado é contado com uma busca;
- É retornado o máximo de 11 endereços ordenados por ordem alfabética do logradouro;
- O retorno do XML utiliza codificação padrão UTF-8.
|
|
Parametros para requisição do endereço
| Nome |
Tamanho |
Tipo de dado |
Obrigatório? |
| formato |
6 |
enum: [xml, string, json] |
Opcional. Caso omitido, assume o formato xml. |
| chave |
100 |
varchar |
Sim. |
| endereco |
100 |
varchar |
Sim. |
| identificador |
6 |
varchar |
Opcional. |
|
|
Variáveis de controle de resultado
| resultado |
resultado_txt |
| 1 |
sucesso. cep encontrado |
| -1 |
cep não encontrado |
| -2 |
formato de cep inválido |
| -3 |
limite de buscas de ip por minuto excedido |
| -4 |
ip banido |
| -5 |
chave banida. contate o administrador |
| -6 |
- |
| -7 |
chave inválida. cadastre-se para continuar utilizando o servico |
| -8 |
chave inativa. |
| -9 |
realize upgrade de sua chave |
| -10 |
sem creditos para pesquisa/aguardando confirmacao pagamento |
| -11 |
muitos resultados. seja mais especifico |
|
acesso ao painel administrativo
