Fatos e fontes
- O leiaute da Receita separa dados da empresa, como capital e porte, de dados dos estabelecimentos, como endereço e CNAEs. Receita Federal — leiaute dos dados abertos do CNPJ.
- CFO: a API oferece busca paginada e consulta de dossiê, com autenticação e cotas documentadas. CFO — documentação da API.
- CFO: o endereço do dossiê inclui complemento e codigo_ibge; o código municipal pode ser null e exige tratamento na integração. CFO — endereço no dossiê.
- CFO: telefone e e-mail podem ser devolvidos mascarados; a integração precisa interpretar o estado de acesso. CFO — documentação da API.
- CFO: a consulta de metadados permite conferir limites e uso da conta, sem consumo de quota segundo a documentação. CFO — documentação da API.
Qual chave deve identificar a empresa no CRM ou ERP?
O CNPJ completo é a chave para o estabelecimento. A raiz pode ser mantida em outro campo para agrupar unidades da pessoa jurídica. Usar apenas a razão social como chave de atualização cria risco de unir homônimos ou sobrescrever uma filial com dados de outra.
| Campo no CRM ou ERP | Origem | Regra de atualização |
|---|---|---|
| CNPJ do estabelecimento | Identificador conferido | Texto, com validação e sem conversão numérica |
| Raiz do CNPJ | Agrupamento cadastral | Manter separada do identificador completo |
| Razão social e situação | Cadastro retornado | Guardar origem e referência |
| CNAEs e endereço | Estabelecimento | Atualizar a unidade correspondente |
| Contato cadastral | Telefone/e-mail da fonte | Respeitar máscara e ausência |
| Contato validado | Conferência da equipe | Preservar até nova validação |
| Última consulta e referência | Processamento e fonte | Guardar em campos distintos |
Quais campos ajudam a preencher o cadastro no ERP?
O dossiê cadastral pode alimentar a identificação de clientes e fornecedores. O mapeamento abaixo descreve campos da API; cada ERP define seus próprios nomes e regras de gravação.
| Campo da API | Uso no cadastro | Regra sugerida |
|---|---|---|
data.cnpj_raw | Identificador do estabelecimento | Guardar como texto; conferir a unidade antes de atualizar |
data.razao_social | Nome empresarial | Manter a fonte e a referência da consulta |
data.endereco | Logradouro, número, complemento, bairro, município, UF e CEP | Mapear separadamente e preservar ausências |
data.endereco.codigo_ibge | Código do município | Conferir os sete dígitos e tratar null |
data.cnae_principal e data.cnae_secundario | Atividades cadastradas | Preservar principal e lista de secundárias |
Os campos completos estão em dossiê da API. O guia de código IBGE pelo CNPJ detalha a conversão municipal. Parâmetros fiscais da emissão precisam de uma etapa própria de validação: o CNAE descreve a atividade cadastrada, e o regime tributário deve conservar fonte e período. Esses registros não preenchem automaticamente todos os campos de uma nota.
Como deve funcionar o fluxo de atualização?
- Validar e normalizar o CNPJ recebido pelo CRM.
- Consultar a operação adequada da API com credencial armazenada no servidor.
- Verificar o status da resposta, o identificador e a referência.
- Aplicar o mapeamento, preservando campos protegidos por validação humana.
- Registrar mudanças e erros para revisão ou nova tentativa controlada.
Como tratar campos vazios e falhas?
Um campo ausente não deve apagar automaticamente uma informação validada. Da mesma forma, contato mascarado não deve substituir o endereço de e-mail de trabalho confirmado. A regra pode guardar o retorno em campos de origem e encaminhar conflitos para conferência.
Exemplo hipotético: o CRM tem contato validado em setembro; a consulta de outubro devolve e-mail mascarado por cota. A integração mantém o contato validado e registra o estado da consulta. Substituir o campo principal pela máscara degradaria o cadastro.
Existe um conector pronto para qualquer CRM?
Este roteiro descreve integração pela API. A compatibilidade depende dos recursos de importação, automação ou desenvolvimento do CRM escolhido. A documentação da API orienta a implementação; o guia não pressupõe um conector nativo para uma plataforma específica.
Como tratar cada erro da API?
A decisão deve combinar o status HTTP com error.code. A documentação de erros do CFO diferencia os casos; as ações abaixo são um roteiro de integração.
| Retorno | Interpretação | Ação |
|---|---|---|
400 · bad_request | Parâmetro inválido | Corrigir a entrada antes de reenviar |
| 401 ou 403 | Credencial ou acesso recusado | Conferir a chave, a conta e as regras de IP; interromper tentativas repetidas |
404 · not_found | CNPJ não localizado na base consultada | Conferir o identificador e a referência; preservar o cadastro existente |
429 · quota_exceeded ou empresa_quota_exceeded | Cota mensal esgotada | Pausar a fila afetada e conferir saldo, renovação e Retry-After |
429 · too_many_timeouts | Pausa da rota secundária de busca | Respeitar Retry-After ou refinar os filtros |
503 · maintenance | Base em recarga | Programar nova tentativa após Retry-After, com limite de tentativas |
200 com contato_mascarado: "cota" na lista | Cadastro retornado com restrição de contato | Preservar o contato validado e registrar a máscara |
O que testar antes de colocar a integração em produção?
O teste deve conferir o que será gravado, incluindo os casos em que a consulta retorna dados incompletos. Erros e esgotamento de cota podem ser simulados com respostas de teste, sem consumir deliberadamente o saldo da conta.
- CNPJ numérico com zero inicial e CNPJ alfanumérico: preservar o identificador como texto durante consulta e gravação.
- Matriz e filial da mesma raiz: atualizar somente a unidade identificada no cadastro de destino.
- CNPJ não encontrado, campo vazio e codigo_ibge nulo: manter a informação validada e sinalizar a pendência.
- Contato mascarado, cota esgotada e manutenção: executar a ação prevista para cada retorno.
- Reprocessamento da mesma resposta: atualizar o registro correspondente sem criar uma segunda ficha para o mesmo CNPJ.
- Registro da execução: guardar resultado, origem e horários sem incluir a chave da API nos registros de erro.
Aplicar esta consulta no CFO
A API REST tem acesso Free com cotas. Autenticação, limites por operação e condições dos planos estão na documentação.
Fontes e orientações conferidas em . Exemplos identificados como hipotéticos ou ilustrativos não representam consultas a empresas reais.