Validar CEP via curl

Rota 1: validar o formato do CEP via curl

Validação offline, instantânea e sem rede. Serve para barrar erro de digitação no formulário antes de qualquer consulta.

#!/usr/bin/env bash
# validador-cep.sh: formato (offline, bash 4+). Use com source ou direto.
# Saída: 0 = formato válido, 1 = inválido

cep_formato_valido() {
  [[ $1 =~ ^[0-9]{5}-?[0-9]{3}$ ]]
}

normaliza_cep() {  # '01310-100' -> '01310100'
  cep_formato_valido "$1" || { echo "CEP com formato inválido: $1" >&2; return 1; }
  echo "${1//-/}"
}

if [[ ${BASH_SOURCE[0]} == "$0" ]]; then
  for cep in "01310-100" "01310100" "1310-100" "01310-10" "abcde-fgh"; do
    if cep_formato_valido "$cep"; then echo "$cep -> formato ok"; else echo "$cep -> formato inválido"; fi
  done
fi

Como o CEP é estruturado (e por que não existe dígito verificador)

Um exemplo calculado à mão, para você conferir o código contra a conta.

CEP 01310-100

0 1 3 1 0 - 1 0 0
| | | | |   +-- 3 últimos dígitos: sufixo de distribuição (identifica o logradouro ou a unidade)
| | | | +-- 5º dígito: subdivisor de subsetor
| | | +-- 4º dígito: subsetor
| | +-- 3º dígito: setor
| +-- 2º dígito: subregião
+-- 1º dígito: região postal (0 = Grande São Paulo)

Não há dígito verificador: nenhuma conta prova que o CEP existe.
Só a consulta à base (ViaCEP) confirma.

Rota 2: confirmar que o CEP existe com o ViaCEP

O ViaCEP responde 400 quando o formato é inválido e 200 com o campo erro quando o formato está certo mas o CEP não existe. O código abaixo trata os dois casos e deixa falha de rede propagar, sem confundir queda de serviço com CEP inexistente.

#!/usr/bin/env bash
# existencia-cep.sh: consulta ViaCEP. Salve a Rota 1 como validador-cep.sh
source ./validador-cep.sh

# Saída: 0 = existe, 1 = não existe ou formato inválido, 2 = falha de rede
cep_existe() {
  cep_formato_valido "$1" || return 1
  local resp
  resp=$(curl -s --max-time 5 "https://viacep.com.br/ws/$(normaliza_cep "$1")/json/") || return 2
  [[ -n $resp && $resp != *'"erro"'* ]]
}

if [[ ${BASH_SOURCE[0]} == "$0" ]]; then
  for cep in "01310-100" "99999-999" "1234"; do
    cep_existe "$cep"; status=$?
    case $status in
      0) echo "$cep -> existe" ;;
      1) echo "$cep -> não existe / formato inválido" ;;
      *) echo "$cep -> falha de rede" ;;
    esac
  done
fi

Como testar CEP no Postman

Cole o script na aba Tests do request. O Postman roda a mesma validação sobre a resposta e marca cada caso como passou ou falhou.

// Postman > aba Tests do request:
// GET https://viacep.com.br/ws/{{cep}}/json/     (variável de ambiente cep = 01310100)

pm.test('status 200', () => pm.response.to.have.status(200));

pm.test('CEP existe (sem campo erro)', () => {
  const dados = pm.response.json();
  pm.expect(dados.erro, 'ViaCEP marcou o CEP como inexistente').to.be.undefined;
});

pm.test('resposta tem endereço coerente', () => {
  const dados = pm.response.json();
  pm.expect(dados.cep).to.match(/^\d{5}-\d{3}$/);
  pm.expect(dados.uf).to.have.lengthOf(2);
  pm.expect(dados.localidade).to.be.a('string').and.not.empty;
});

// Para o caso negativo, crie outro request com cep = 99999999 e troque o teste por:
// pm.expect(pm.response.json().erro).to.exist;

Validar CEP: algoritmo local ou serviço externo

Perguntas frequentes sobre validar CEP via curl

Páginas relacionadas