e-mail contato@buscarcep.com.br ou fale conosco acesso ao painel administrativo
Web Service de buscas de Endereços e SMS
 
principal contratar ceps exemplos planos web service
contratar SMS
 
Especificação Técnica | SMS
 

Chave para testes: Chave_Gratuita_BuscarCep
Esta chave permite envios de teste para fins de manipulação dos retornos do web service, porém os SMS enviados não chegam ao destino.

HTTPS/SSL SMS:
https://buscarcep.com.br/ws2/?telefone=5531986251000&texto=SEU_TEXTO&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1

HTTPS/SSL Conultando status de SMS:
https://buscarcep.com.br/ws2/?eid=NUMERO_ID_ENVIO&chave=Chave_Gratuita_BuscarCep

CONSULTANDO CRÉDITOS:
http://buscarcep.com.br/ws2/?chave=Chave_Gratuita_BuscarCep

#1 - Enviando SMS

Tipo Formato URL
SMS https://buscarcep.com.br/ws2/?telefone=5531986251000&texto=SEU_TEXTO&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1
  • Todos os valores em negrito são obrigatórios, exceto o parâmetro identificador;
  • O tipo SMS é enviado somente para celulares;
  • Mensagens de massa (iguais) serão automaticamente priorizadas pelo sistema e adicionado um #ID_ENVIO ao final da mesma, afim de evitar bloqueios das Operadoras;
  • Todas as respostas a SMS serão enviados via POST a URL configurada em seu cadastro, no menu Meus Dados.

Parâmetros para envio do SMS

Nome Tamanho Tipo de dado Obrigatório?
telefone - varchar Sim. Formato: Código País + Código de Área + Telefone.
Ex.: 5531986251000
texto 160 varchar Sim. Caso envie SMS.
chave 100 varchar Sim.
identificador 100 varchar Opcional.
tel_retorno 255 varchar Opcional.
Ex.: 5531986251001

* Por padrão, todas as mensagens SMS enviadas esperam resposta do destinatário, e caso sejam respondidas pelo destinatário as respostas serão vinculadas ao último SMS enviado a ele. O vínculo é realizado pelo campo telefone da mensagem enviada com o telefone da mensagem de resposta. Portanto evite enviar várias perguntas/SMS (para um mesmo telefone) esperando uma resposta, tente realizar e aguardar uma resposta por vez (para um mesmo telefone).

* O parâmetro tel_retorno informa para qual telefone será enviado as respostas de quem responder as suas mensagens enviadas. Este recurso é gratuito e não gera custo.

 

Parâmetros de retorno da solicitação

Nome Descrição retorno
id_envio Identificador único da sua transação. Com este identificador que o buscar cep te retorna você pode consultar o status de suas transações.
resultado  
resultado_txt  

Variáveis de controle de resultado

resultado resultado_txt
1 sucesso
-1 credito insuficiente
-2 descontinuado
-3 chave inexistente
-4 parametros incorretos
-5 descontinuado
-6 sem sms pendentes para envio
-7 celular nao cadastrado para envio
-8 texto invalido ou com caracteres especiais

#2 - Consultando status SMS

Tipo Formato URL
SMS https://buscarcep.com.br/ws2/?eid=NUMERO_ID_ENVIO&chave=Chave_Gratuita_BuscarCep
  • Todos os valores em negrito são obrigatórios.

Parâmetros para solicitação de status

Nome Tamanho Tipo de dado Obrigatório?
eid 10 int Sim.
chave 100 varchar Sim.

Parâmetros de retorno da solicitação

Nome Descrição retorno
id_envio ID do envio solicitado.
enviado "a" para aguardando; "s" para enviado e "e" para erro.
ret_codigo "SMS_delivered" para entregue; "SMS_sent" para enviado; "Generic_failure" para erro; ou vazio.
data_registro Data da solicitação em formato americano.
data_envio Data de envio em formato americano.
identificador Identificador enviado na solicitação.
resultado  
resultado_txt  

Variáveis de controle de resultado

resultado resultado_txt
1 sucesso
-1 retorno nao encontrado

#3 - Consultando respostas de um SMS

Tipo Formato URL
SMS https://buscarcep.com.br/ws2/?eid=NUMERO_ID_ENVIO&resposta=s&chave=Chave_Gratuita_BuscarCep
  • Todos os valores em negrito são obrigatórios.

Parâmetros para solicitação de status

Nome Tamanho Tipo de dado Obrigatório?
eid 10 int Sim.
resposta 1 varchar Sim. Aceita "s".
chave 100 varchar Sim.

Parâmetros de retorno da solicitação

Nome Descrição retorno
id_resposta ID da resposta.
telefone Telefone da resposta.
resposta Texto da resposta.
data_registro Data da resposta.
resultado  
resultado_txt  

Variáveis de controle de resultado

resultado resultado_txt
1 sucesso
-1 resposta nao encontrada
 
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
  • 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 5 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] 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. contate o administrador
-5 chave banida. contate o administrador
-6 entre 0 e 6 horas da madrugada todas as buscas são limitadas a 5 buscas por minuto
-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
 
 
 
     
www.buscarcep.com.br | política de uso | fale conosco | EUA um produto desenvolvido por
Host-Up Soluções Web