API de CEP no VBA – Como Buscar Endereços Usando o VBA?

Você sabia que é possível buscar endereços usando o Excel? Eu vou te mostrar como fazer isso com a API de CEP no VBA!

Para buscar endereços por CEP no VBA, faça uma requisição HTTP a uma API de CEP (como a ViaCEP) usando o objeto MSXML2.XMLHTTP. O VBA envia o CEP, recebe a resposta em JSON com rua, bairro, cidade e estado, e você preenche as células da planilha automaticamente a partir desses dados.

Caso prefira esse conteúdo no formato de vídeo-aula, assista ao vídeo abaixo!

O que você aprende neste vídeo

Resposta rápida: A macro trata o CEP digitado em B1, monta o link da API do ViaCEP, confere o status da requisição, converte a resposta e preenche a coluna B, testada linha por linha e com dois CEPs. Ela segue o modelo de leitura de API de uma aula anterior do canal, que traz as duas referências e o módulo de conversão.

Neste vídeo (14 min):

  • 1:16 - A API do ViaCEP e a documentação dela
  • 2:21 - No fim do link, o formato da resposta: JSON ou XML
  • 4:08 - As duas referências habilitadas em Ferramentas, Referências, e o módulo conversor de JSON
  • 4:41 - As variáveis da macro: requisição, resposta, URL, parâmetros e CEP
  • 5:35 - A macro começa limpando de B2 até B10, sem apagar o CEP em B1
  • 6:04 - Vários Replace, um dentro do outro, tiram ponto, hífen e espaço do CEP
  • 7:22 - Com Len, a macro sai se o CEP tiver mais de oito caracteres
  • 8:28 - A requisição GET com o Open, juntando a URL e os parâmetros
  • 9:01 - O tratamento de erro da requisição
  • 10:30 - A macro executada linha por linha com F8
  • 11:16 - Um ponto de interrupção e F5, para não entrar no módulo de conversão
  • 12:53 - Um segundo CEP, só com traço, também preenche o endereço

Trechos do vídeo:

  • A API do ViaCEP pede o CEP com oito dígitos e sem mais nada: nem ponto, nem hífen, nem espaço, nem letra.
  • O VBA não lê JSON. É o módulo conversor de JSON que transforma a resposta em estruturas que o VBA entende.
  • O status 200 indica que a requisição deu certo; se for diferente disso, a macro mostra o erro numa caixa de mensagem e sai.
  • Para ver tudo o que uma variável guarda durante a execução, use Exibir, Variáveis locais: ali aparecem todas as variáveis da macro em execução, com cada item da resposta pelo nome.
  • A mesma API também busca pelo endereço: com estado, cidade e logradouro, ela devolve informações de CEP.

Para receber por e-mail o(s) arquivo(s) utilizados na aula, preencha:

Fala, Impressionadores! Hoje você vai ver como buscar endereços com VBA!

Para conseguir tal feito, nós vamos fazer uso de uma API de CEP no VBA chamada ViaCEP. Ela vai permitir com que você faça uma busca através do CEP e obtenha várias informações a respeito daquele local.

Nós temos um outro post no Blog de como usar API no VBA, que ajuda a entender o que vamos mostrar na aula de hoje. Seria recomendável que você assista essa aula antes do post de hoje, que vem a seguir.

E aí, vamos aprender a buscar CEP com VBA para implementar nos seus projetos?

Inicialmente já temos uma tabela montada para receber as informações que vão ser conseguidas com o sucesso da API. Veja-a abaixo:

API de CEP no VBA

Como funciona?

Preencheremos um CEP, com pontos e hífen, como normalmente temos para esse código postal.

Ao clicar no botão de atualizar, o nosso código vai funcionar e retornar as informações apresentadas, até a linha 10.

Ativando referências no VBA

A seguir temos um fator super importante para o desempenho da API da forma como esperamos na aula de hoje: teremos que ativar duas referências, pra ser mais específicos.

São elas as referências “Microsoft WinHTTP Services” (como na foto abaixo) e também a “Microsoft Scripting Runtime”. Veja:

API de CEP no VBA

Após ativá-las, poderemos partir para o código que vai desempenhar a API de CEP no VBA, que vai fazer a busca de endereços com VBA, e que está a seguir:

VBA
<strong>Sub APIViaCEP()</strong><br><br><strong>'https://viacep.com.br/</strong><br><br><strong>Dim requisicao As New WinHttpRequest</strong><br><strong>Dim resposta As Object</strong><br><strong>Dim url As String, parametros As String, cep As String</strong><br><br><strong>Range("B2:B10").ClearContents</strong><br><br><strong>' Tratamento do CEP</strong><br><strong>cep = Replace(Replace(Replace(Range("B1").Value, ".", ""), "-", ""), " ", "")</strong><br><br><strong>If Len(cep) > 8 Then Exit Sub</strong><br><br><strong>' Definir a URL e os parâmetros</strong><br><strong>url = "https://viacep.com.br/ws/"</strong><br><strong>parametros = cep & "/json/"</strong><br><br><strong>' Enviar a requisição</strong><br><strong>requisicao.Open "Get", url & parametros</strong><br><strong>requisicao.Send</strong><br><br><strong>' Tratamento de erros</strong><br><strong>If requisicao.Status <> 200 Then</strong><br><strong>    MsgBox "Erro: " & requisicao.ResponseText</strong><br><strong>    Exit Sub</strong><br><strong>End If</strong><br><br><strong>' Converter o JSON</strong><br><strong>Set resposta = JsonConverter.ParseJson(requisicao.ResponseText)</strong><br><br><strong>' Tratar as informações</strong><br><strong>Cells(2, 2).Value = resposta("logradouro")</strong><br><strong>Cells(3, 2).Value = resposta("complemento")</strong><br><strong>Cells(4, 2).Value = resposta("bairro")</strong><br><strong>Cells(5, 2).Value = resposta("localidade")</strong><br><strong>Cells(6, 2).Value = resposta("uf")</strong><br><strong>Cells(7, 2).Value = resposta("ibge")</strong><br><strong>Cells(8, 2).Value = resposta("gia")</strong><br><strong>Cells(9, 2).Value = resposta("ddd")</strong><br><strong>Cells(10, 2).Value = resposta("siafi")</strong><br><br><strong>Range("B:B").Columns.AutoFit</strong><br><br><strong>End Sub</strong>
Ícone VBAVBA Impressionador

Como automatizar praticamente qualquer tarefa repetitiva que você faça dentro do Excel. Aprenda a criar integrações do Excel com o PowerPoint, Word, Outlook e muito mais. Aprenda a criar automações para resolver tudo com apenas um clique em um botão. Tudo isso com uma única linguagem que junta todos esses programas.

Black Friday · Lote Especial · Lote 1 · Último Lote

De R$ 1.497 56% OFF54% OFF53% OFF

por 12x R$ 6467,5069

Preço do Lote Especial por tempo limitadoPreço do Lote Especial só até amanhã, 13/11, às 23h59Preço do Lote Especial até 13/11, às 23h59Último dia do Lote Especial: o preço vale até hoje, às 23h59Preço do Lote 1 por tempo limitadoPreço do Lote 1 só até amanhã, 20/11, às 23h59Preço do Lote 1 até 20/11, às 23h59Último dia do Lote 1: o preço vale até hoje, às 23h59Preço do Último Lote por tempo limitadoPreço do Último Lote só até amanhã, 27/11, às 23h59Preço do Último Lote até 27/11, às 23h59Último dia do Último Lote: o preço vale até hoje, às 23h59

Começar agoraQuero a oferta de Black FridaySeta para a direita
Fundo VBATelas VBA

Explicação do código em VBA:

  • Dimensionar:
    • a variável “requisicao” como sendo do tipo um novo objeto do tipo WinHttpRequest, que é um objeto da biblioteca que ativamos, a “Microsoft WinHTTP Services”
    • a variável “resposta” como um objeto
    • as variáveis “url”, “parametros” e “cep” como do tipo texto
  • Limpar o conteúdo das células contidas no intervalo de B2 a B10
  • Armazenar na variável “cep” o que estiver na célula “B1”, retirando os caracteres “.”, “,” e “-“ (ponto, vírgula, e hífen, respectivamente). Isso é necessário porque a requisição deve ter um padrão específico (os parâmetros não podem ter esses caracteres). É aqui que fazemos a verificação de dígitos no VBA
  • Fazer uma validação do CEP através de uma estrutura If de comparação para testar se o CEP digitado na célula B1 tem mais de 8 caracteres. Se for digitado um número de caracteres maior do que 8, depois de tratados os caracteres (etapa acima), o código será abortado
  • Armazenar na variável “url” o texto que corresponde ao site exatamente que vamos acessar para pegar as informações, que é o link disponibilizado (site VIACEP)
  • Armazenar na variável “parametros” os parâmetros variáveis do link da API, levando em consideração o “cep”, e o final padronizado como “/json/”
  • Abrir (do inglês “open”) o objeto que é representado pela variável “requisicao”, passando os argumentos “url” e “parametros”, dos quais ela vai pegar informações (get, em inglês)
  • Passar para o cabeçalho da “requisicao” os parâmetros “padrão” informados pela API
  • Dar o comando de “enviar” requisição (send, em inglês), que é de fato quando o VBA envia a requisição para o site
  • Com um tratamento de erros no VBA, iremos verificar se o “Status” da variável “requisicao” é diferente de 200 (porque essa resposta é a esperada quando uma resposta válida é retornada pela API):
  • Dando tudo certo no envio da requisição ao site, e tendo o “Status” com valor de 200, iremos configurar a variável “resposta” para receber o objeto da biblioteca JSON, que vai ser responsável por retornar a resposta, em texto, da “requisicao”. É aqui que vamos, de fato, converter o JSON
  • Pegar as informações que vêm da variável “resposta” da seguinte forma:
    • A célula da 2ª linha e 2ª coluna (B) vai receber o valor que estiver no item “logradouro” da variável “resposta”
    • A célula da 3ª linha e 2ª coluna (B) vai receber o valor que estiver no item “complemento” da variável “resposta”
    • A célula da 4ª linha e 2ª coluna (B) vai receber o valor que estiver no item “bairro” da variável “resposta”
    • A célula da 5ª linha e 2ª coluna (B) vai receber o valor que estiver no item “localidade” da variável “resposta”
    • A célula da 6ª linha e 2ª coluna (B) vai receber o valor que estiver no item “uf” da variável “resposta”
    • A célula da 7ª linha e 2ª coluna (B) vai receber o valor que estiver no item “ibge” da variável “resposta”
    • A célula da 8ª linha e 2ª coluna (B) vai receber o valor que estiver no item “gia” da variável “resposta”
    • A célula da 9ª linha e 2ª coluna (B) vai receber o valor que estiver no item “ddd” da variável “resposta”
    • A célula da 10ª linha e 2ª coluna (B) vai receber o valor que estiver no item “siafi” da variável “resposta”
  • Fazer o ajuste automático de colunas (especificamente da coluna B), para que todas as informações fiquem visíveis/caibam dentro da largura da coluna
  • Se encerra o código

Veja, abaixo, dois exemplos de CEPs pesquisados, com a API:

API de CEP no VBA
Autofit no VBA
API de CEP no VBA

Observe que, para os dois casos, a API funcionou normalmente, e a coluna ficou com tamanhos diferentes, para caber as informações, sejam elas maiores ou menores.

Conclusão – API de CEP no VBA

Hoje você aprendeu a lidar com API no VBA! Mais especificamente falando buscar informações de CEP com VBA!

Entendeu como funciona a API, como é sua resposta, e viu um código que pode trazer as informações para o Excel!

Pôde realizar o tratamento de informações, manipular os dados conseguidos com a API, lidando com estruturas do VBA que lidamos em outras aulas: estrutura If, Tratamento de erros, funções de texto para verificação de dígitos.

Valeu, Impressionadores! Fique ligado no nosso canal do Youtube para mais conteúdo de VBA! Um abraço!

Hashtag Treinamentos

Para acessar outras publicações de VBA, clique aqui!


Quer aprender mais sobre VBA com um minicurso básico gratuito?

1. Como buscar endereço por CEP no Excel com VBA?

Crie uma macro que envia o CEP a uma API (como a ViaCEP) usando MSXML2.XMLHTTP, leia a resposta em JSON e preencha as células com rua, bairro, cidade e estado. Assim a busca fica automática a partir do CEP digitado.

2. O que é a API ViaCEP?

É um serviço gratuito que retorna os dados de endereço a partir de um CEP brasileiro, em formato JSON. Basta fazer uma requisição com o CEP na URL e ela devolve logradouro, bairro, cidade e UF.

3. Como ler JSON no VBA?

O VBA não tem leitor de JSON nativo, mas dá para extrair os campos com funções de texto (como Split e InStr) ou usar uma biblioteca como o VBA-JSON, que converte a resposta em um objeto fácil de acessar.

4. Preciso de internet para a busca de CEP no VBA?

Sim. A consulta usa uma API online, então é necessária conexão com a internet para enviar o CEP e receber os dados do endereço em tempo real.