Como consultar CNPJ via API no Ruby.
Aprenda a consultar CNPJ via API no Ruby com Net::HTTP: código pronto, leitura do JSON, tratamento de erros e boas práticas. API de CNPJ grátis, sem chave e sem cadastro.
Por que usar a API do openCNPJ no Ruby
Em Ruby e Ruby on Rails, a consulta de CNPJ via API ajuda a validar e completar cadastros automaticamente. O exemplo usa apenas net/http e json, da biblioteca padrão.
- Grátis, sem chave de acesso e sem cadastro.
- Resposta em JSON com razão social, situação cadastral, endereço, CNAEs, sócios e Simples Nacional.
- Aceita o CNPJ numérico e o novo CNPJ alfanumérico.
- Limite de 10 requisições por segundo por IP.
O que você precisa
Ruby 2.7 ou superior. net/http e json fazem parte da biblioteca padrão.
Consultar um CNPJ no Ruby
O endpoint é GET https://api.opencnpj.com.br/cnpj/{cnpj}. Envie o CNPJ com 14 caracteres, sem pontos, barra ou hífen. O exemplo abaixo consulta o CNPJ 06.990.590/0001-23:
require "net/http"
require "json"
cnpj = "06990590000123"
resposta = Net::HTTP.get_response(URI("https://api.opencnpj.com.br/cnpj/#{cnpj}"))
raise "HTTP #{resposta.code}" unless resposta.is_a?(Net::HTTPSuccess)
empresa = JSON.parse(resposta.body)
puts empresa["razao_social"]
puts empresa.dig("estabelecimento", "situacao_cadastral")Remover a máscara do CNPJ
Se o CNPJ vem formatado (06.990.590/0001-23) de um formulário, banco de dados ou planilha, limpe a pontuação antes de montar a URL. A mesma regra funciona para o CNPJ alfanumérico:
def limpar_cnpj(cnpj)
cnpj.gsub(/[^0-9A-Za-z]/, "").upcase
end
cnpj = limpar_cnpj("06.990.590/0001-23") # "06990590000123"
Campos mais usados da resposta
| Campo | Conteúdo |
|---|---|
razao_social | Nome empresarial |
estabelecimento.nome_fantasia | Nome fantasia |
estabelecimento.situacao_cadastral | Ativa, Suspensa, Inapta, Baixada ou Nula |
estabelecimento.atividade_principal | CNAE principal, com código e descrição |
estabelecimento.cidade.nome e estabelecimento.estado.sigla | Município e UF |
estabelecimento.cep, logradouro, numero, bairro | Endereço |
simples.simples e simples.mei | Opção pelo Simples Nacional e MEI |
socios | Quadro de sócios e administradores |
A lista completa de campos está na documentação da API.
Tratando erros
Verifique o status HTTP antes de ler o JSON. Ruby: use resposta.code.
| Status | O que significa | O que fazer |
|---|---|---|
200 | CNPJ encontrado | Ler o JSON |
400 | Formato de CNPJ inválido | Conferir os 14 caracteres |
404 | CNPJ não encontrado na base | Informar ao usuário |
429 | Limite de requisições excedido | Aguardar e tentar de novo |
500 | Erro interno | Tentar novamente mais tarde |
Os erros também vêm em JSON, com os campos status, titulo e detalhes.
Boas práticas
- Defina um timeout na requisição, por exemplo com
open_timeouteread_timeoutdoNet::HTTP. - Guarde o resultado em cache se o mesmo CNPJ for consultado com frequência.
- Em processamentos em lote, respeite o limite de 10 requisições por segundo.
- Os dados refletem a base pública mais recente processada e não substituem certidões oficiais.
Perguntas frequentes
A API de CNPJ do openCNPJ é gratuita?
Sim, 100% grátis. Não há chave de acesso nem cadastro. O limite é de 10 requisições por segundo por IP.
Funciona no Rails?
Sim. Use o mesmo código em um service object ou job, ou troque por Faraday ou HTTParty se o projeto já usa uma dessas gems.
Como acessar campos aninhados com segurança?
Use dig: empresa.dig("estabelecimento", "cidade", "nome") retorna nil se algum nível não existir.
De onde vêm os dados do CNPJ?
Dos dados abertos do CNPJ publicados pela Receita Federal, complementados por bases públicas. Os dados podem ter defasagem e não substituem certidões oficiais. Veja a origem dos dados.