API e uso dos dados

Como integrar dados de CNPJ ao CRM e ao ERP?

A integração com CRM ou ERP deve identificar cada estabelecimento pelo CNPJ completo, mapear os campos da resposta e definir regras de atualização. O dossiê do CFO fornece dados como razão social, CNAEs, endereço e código IBGE do município. A aplicação deve preservar informações já validadas, tratar campos ausentes e conferir a resposta antes de gravar o cadastro.

Publicado em · Atualizado em

Fatos e fontes

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.

Mapa sugerido de campos
Campo no CRM ou ERPOrigemRegra de atualização
CNPJ do estabelecimentoIdentificador conferidoTexto, com validação e sem conversão numérica
Raiz do CNPJAgrupamento cadastralManter separada do identificador completo
Razão social e situaçãoCadastro retornadoGuardar origem e referência
CNAEs e endereçoEstabelecimentoAtualizar a unidade correspondente
Contato cadastralTelefone/e-mail da fonteRespeitar máscara e ausência
Contato validadoConferência da equipePreservar até nova validação
Última consulta e referênciaProcessamento e fonteGuardar 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.

Mapa do dossiê para o cadastro do ERP
Campo da APIUso no cadastroRegra sugerida
data.cnpj_rawIdentificador do estabelecimentoGuardar como texto; conferir a unidade antes de atualizar
data.razao_socialNome empresarialManter a fonte e a referência da consulta
data.enderecoLogradouro, número, complemento, bairro, município, UF e CEPMapear separadamente e preservar ausências
data.endereco.codigo_ibgeCódigo do municípioConferir os sete dígitos e tratar null
data.cnae_principal e data.cnae_secundarioAtividades cadastradasPreservar 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?

  1. Validar e normalizar o CNPJ recebido pelo CRM.
  2. Consultar a operação adequada da API com credencial armazenada no servidor.
  3. Verificar o status da resposta, o identificador e a referência.
  4. Aplicar o mapeamento, preservando campos protegidos por validação humana.
  5. 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.

Resposta da API e ação sugerida
RetornoInterpretaçãoAção
400 · bad_requestParâmetro inválidoCorrigir a entrada antes de reenviar
401 ou 403Credencial ou acesso recusadoConferir a chave, a conta e as regras de IP; interromper tentativas repetidas
404 · not_foundCNPJ não localizado na base consultadaConferir o identificador e a referência; preservar o cadastro existente
429 · quota_exceeded ou empresa_quota_exceededCota mensal esgotadaPausar a fila afetada e conferir saldo, renovação e Retry-After
429 · too_many_timeoutsPausa da rota secundária de buscaRespeitar Retry-After ou refinar os filtros
503 · maintenanceBase em recargaProgramar nova tentativa após Retry-After, com limite de tentativas
200 com contato_mascarado: "cota" na listaCadastro retornado com restrição de contatoPreservar 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.

  1. CNPJ numérico com zero inicial e CNPJ alfanumérico: preservar o identificador como texto durante consulta e gravação.
  2. Matriz e filial da mesma raiz: atualizar somente a unidade identificada no cadastro de destino.
  3. CNPJ não encontrado, campo vazio e codigo_ibge nulo: manter a informação validada e sinalizar a pendência.
  4. Contato mascarado, cota esgotada e manutenção: executar a ação prevista para cada retorno.
  5. Reprocessamento da mesma resposta: atualizar o registro correspondente sem criar uma segunda ficha para o mesmo CNPJ.
  6. 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.