API do Omie para certidões: o que a integração lê e grava
A integração usa a API do Omie em duas direções. Lê os clientes e fornecedores pelo serviço de clientes, com o token do aplicativo. Grava o resultado de cada certidão no cadastro: o PDF pelo serviço de anexos, na tabela cliente, e a situação e a validade na ficha. Ninguém da TI precisa escrever código: a conexão é feita na tela da Hath.
- Fonte
- Caixa Econômica Federal
- Você envia
- CNPJ lido do cadastro do Omie
- Volta
- JSON e PDF oficial
- Situação
- Em produção
Da documentação oficial, só o que a integração usa
| Serviço do Omie | Para quê | Detalhe da documentação |
|---|---|---|
| Chave do aplicativo (app_key e app_secret) | Autenticar a conexão | Gerada em Meus Aplicativos; a Omie recomenda que o parceiro tenha uma tela para o usuário colar a chave |
| geral/clientes | Ler a carteira de clientes e fornecedores | Cliente e fornecedor são o mesmo cadastro; até 100 registros por página |
| geral/anexo | Guardar o PDF da certidão no cadastro | IncluirAnexo com tabela "cliente"; arquivo compactado em zip, em base 64, com o MD5 |
Chave do aplicativo (app_key e app_secret)
- Para quê:
- Autenticar a conexão
- Detalhe da documentação:
- Gerada em Meus Aplicativos; a Omie recomenda que o parceiro tenha uma tela para o usuário colar a chave
geral/clientes
- Para quê:
- Ler a carteira de clientes e fornecedores
- Detalhe da documentação:
- Cliente e fornecedor são o mesmo cadastro; até 100 registros por página
geral/anexo
- Para quê:
- Guardar o PDF da certidão no cadastro
- Detalhe da documentação:
- IncluirAnexo com tabela "cliente"; arquivo compactado em zip, em base 64, com o MD5
Todas as chamadas da API do Omie são POST, em JSON ou SOAP. A lista completa está no portal do desenvolvedor do Omie.
O resultado que vira anexo, situação e validade
Você envia
- CNPJ lido do cadastro do Omie
RespostaJSONEm uma linha
CRF do FGTS: REGULAR · válido até 22/11/2026 · PDF anexado ao cadastro
{
"protocolo": "a1b2c3d4",
"status": "concluida",
"cnpj": "00.000.000/0001-00",
"certidao": "crf_fgts",
"orgao": "Caixa Econômica Federal",
"resultado": {
"situacao": "regular",
"resumo": "A empresa está regular perante o FGTS",
"numero": "0000000000000000000000",
"emitida_em": "2026-10-23",
"valida_ate": "2026-11-22"
},
"pdf_url": "https://…/certidao.pdf"
}Como ler
resultado.situacao- Vai para a ficha do cadastro como a situação da certidão. regular ou irregular no FGTS; negativa, positiva com efeito de negativa ou pendência nas outras.
resultado.valida_ate- Vai para a ficha como a validade, e é a data que agenda a próxima consulta.
pdf_url- O PDF do órgão. É ele que a integração compacta e envia ao serviço de anexos do Omie, no cadastro daquele CNPJ.
status- concluida quando o órgão respondeu; em_andamento enquanto a fonte não libera (o resultado chega por webhook); fonte_indisponivel quando o portal está fora do ar, que nunca vira "nada consta".
Por que a carteira grande não trava a API
- Até 240 requisições por minuto para cada combinação de IP, chave e método, e 960 por minuto por IP.
- Até 4 requisições simultâneas por IP, chave e método.
- O mesmo registro consultado duas vezes em 60 segundos só devolve dados na primeira.
- Até 100 registros por página nas listagens.
Conecte o Omie com a chave do aplicativo e acompanhe as chamadas
Dúvidas frequentes
Fale direto com quem constrói o robô. A gente olha a fonte, o volume e o destino antes de qualquer proposta.
Falar com quem faz a coletaFontes e método
Os prazos e as regras citados vêm dos textos legais abaixo e da operação diária de emissão da Hath Data.
A coleta é feita em fonte pública oficial: a Hath Data não é a fonte e não certifica o conteúdo publicado pelo órgão. O serviço é prestado sob contrato, o cliente é o controlador dos dados e declara a finalidade; a Hath atua como operadora. Nomes de órgãos são citados apenas para identificar a fonte, sem vínculo ou endosso. Veja os termos de uso e a política de privacidade.