Integração CNPJA

Leitura estimada: 4 minutos 3 visualizações

Visão geral

A integração com a CNPJá permite buscar automaticamente os dados cadastrais de uma empresa a partir do CNPJ, preenchendo os campos do cadastro (razão social, nome fantasia, endereço, CEP, bairro, cidade, estado, inscrições etc.) sem digitação manual. A consulta é acionada pelo botão Consultar, exibido ao lado do campo de CNPJ nos formulários de cadastro de Clientes e Fornecedores.

Origem dos dados

Os dados são fornecidos pela CNPJá (https://api.cnpja.com): informações cadastrais de pessoa jurídica originadas da Receita Federal do Brasil (CNPJ), complementadas — conforme o plano e os parâmetros da consulta — com Simples Nacional e Inscrições Estaduais (Sintegra/SEFAZ). Endpoint: GET https://api.cnpja.com/office/{CNPJ}, com parâmetros opcionais como ?simples=true e ?registrations=BR.

Importante: a solução apenas consome e exibe as informações retornadas pela CNPJá, não sendo a fonte primária nem responsável por divergências ou desatualizações na base de origem.

Pré-requisitos e dependências técnicas

  • Token da consulta (fornecido pela BOA Digital) — o token de API é fornecido e configurado pela equipe BOA Digital durante a implantação. O cliente não precisa contratar conta ou plano próprios na CNPJá.
  • Acesso de rede (saída HTTPS) — liberação para https://api.cnpja.com (porta 443) a partir do ambiente Fluig e dos navegadores dos usuários. Em ambientes com proxy/firewall, o domínio deve ser liberado.
  • Solução instalada
  • Usuário com permissão para executar a tela de configuração de Serviços da solução.

Configuração e habilitação

Toda a configuração é feita em uma única tela: a tela de Serviços da solução (etapa de instalação/configuração). Ao preencher os campos de consulta e salvar, a própria solução cria (ou atualiza) automaticamente o serviço CNPJA na plataforma Fluig (serviço REST) e grava os parâmetros — não é necessário cadastrar o serviço manualmente no Painel de Controle.

Na seção de Consulta de CNPJ da tela de Serviços:

  • Tipo CNPJ (tipo_cnpj): provedor da consulta. Ex.: cnpja
  • URL CNPJ (url_cnpj): endpoint com o marcador ||cnpj||, substituído pelo CNPJ na consulta. Ex.: https://api.cnpja.com/office/||cnpj||?registrations=BR
  • Token / Parâmetro (par_cnpj): token da CNPJá, enviado no cabeçalho Authorization a cada consulta. (fornecido pela BOA Digital)

O campo Token / Parâmetro já é preenchido com o token fornecido pela BOA Digital no momento da implantação. Não é necessário que o cliente gere ou informe um token próprio.

Ao salvar:

  • A solução verifica se o serviço CNPJA já existe na plataforma; se não existir, cria; se existir, atualiza com a URL informada.
  • Os parâmetros (tipo, URL e token) ficam gravados no formulário de Serviços e passam a ser usados pelo botão Consultar nos cadastros.

Como utilizar

  • No cadastro de Cliente ou Fornecedor, informe o CNPJ no campo correspondente.
  • Clique no botão Consultar ao lado do campo.
  • A solução consulta a CNPJá e preenche automaticamente os campos disponíveis (nome, endereço, CEP, bairro, cidade, UF etc.).
  • Cada consulta é registrada em log (CNPJ, dados retornados, data e hora). Se já houver consulta recente para o mesmo CNPJ, o sistema oferece reaproveitar a consulta anterior ou realizar nova consulta, evitando consumo desnecessário.

Limitações e premissas

  • Token fornecido pela BOA Digital — o token e o plano da CNPJá são fornecidos e gerenciados pela EZ4; o volume de consultas está sujeito aos limites do plano contratado pela BOA Digital.
  • Dependência de disponibilidade externa — se a API da CNPJá estiver indisponível ou a rede bloqueada, a consulta não retorna dados. A chamada possui timeout (é interrompida se o serviço não responder em poucos segundos).
  • Qualidade do dado — os campos preenchidos dependem do que a base de origem disponibiliza; empresas com cadastro incompleto podem retornar campos em branco.

Erros comuns

  • Consulta retorna vazia → Token inválido/expirado ou CNPJ sem dados na base → Contatar o suporte EZ4; confirmar o CNPJ.
  • “Nenhum resultado” / timeout → Rede sem liberação para api.cnpja.com ou API fora do ar → Liberar o domínio no firewall/proxy; tentar novamente.
  • Falha após muitas consultas → Limite do plano atingido → Aguardar; contatar o suporte EZ4.

Deixe seu comentário

Compartilhar este Documento

Integração CNPJA

Copiar Link

Conteúdo