• Instagram
  • Facebook
  • Twitter
  • LinkedIn

© CNPJá! 2020 • Todos os Direitos Reservados

GUIA RÁPIDO

5 min

Consulta Receita Federal em Tempo Real [ 1 ₪ ]

1

Obtenha sua Chave de API gratuitamente na página Minha Conta.

É necessário realizar login utilizando seu e-mail ou rede social.

2

Prepare uma requisição  GET  para:

3

Adicione nos Headers da requisição a propriedade de autenticação:

Authorization: *ChaveDeAPI*

4

Substitua o *CNPJ* pelos 14 dígitos, sem pontuação, a consultar.

E a *ChaveDeAPI* pelos 76 caracteres adquiridos no Passo 1.

SINTEGRA e Simples Nacional do Cache [ +0 ₪ ]

Ao enviar a requisição acima, além das informações da Receita Federal, o objeto de retorno conterá os dados em Cache do SINTEGRA e Simples Nacional.

Estas informações extras são fornecidas como cortesia.

Todavia não garantimos a presença em 100% das requisições, e pode ocorrer casos onde o retorno estará em branco.

Se os dados destes sistemas forem críticos a sua aplicação, refira-se as consultas em Tempo Real após os exemplos.

EXEMPLOS

Escolha ao lado a linguagem de sua preferência e substitua as variáveis:

*CNPJ*

14 dígitos do CNPJ a ser consultado

(sem pontuação).

*CHAVE-DE-API*

Sua Chave encontrada em Minha Conta.

Consulta SINTEGRA em Tempo Real [ +15 ₪ ]

Para habilitar, adicione o parâmetro a seguir na requisição:

https://api.cnpja.com.br/companies/*CNPJ*?sintegra_max_age=*Defasagem*

Ao fornecer a propriedade sintegra_max_age você está sujeito a receber um acréscimo no custo da requisição caso necessitemos adquirir o dado em Tempo Real.

Substitua a *Defasagem* pelo número máximo em dias passados que você aceitaria um dado em Cache do SINTEGRA.

Se nossa informação cacheada o atender, iremos retorná-la sem cobrança adicional.

Caso contrário, uma consulta em Tempo Real será feita e o valor extra aplicado.

Consulta Simples Nacional em Tempo Real [ +30 ₪ ]

Para habilitar, adicione o parâmetro a seguir na requisição:

https://api.cnpja.com.br/companies/*CNPJ*?simples_max_age=*Defasagem*

Funcionamento idem ao descrito acima, refira-se a ele para explicações.

EXEMPLOS ADICIONAIS

Siga os mesmo passos do exemplo anterior para *CNPJ**CHAVE-DE-API*.

Substitua as novas variáveis:

*SINTEGRA-IDADE-MAX*

*SIMPLES-IDADE-MAX*

Tempo máximo em dias que você aceita informações cacheadas de cada serviço.

Se nosso Cache for mais antigo que o aceitável, uma requisição em Tempo Real será realizada.

OPÇÕES AVANÇADAS

Receita Federal do Cache [ -0,8 ₪ ]

Para configurar, adicione o parâmetro a seguir na requisição:

https://api.cnpja.com.br/companies/*CNPJ*?company_max_age=*Defasagem*

Substitua a *Defasagem* pelo número máximo em dias que você aceitaria um dado em Cache da consulta a Receita Federal.

Se nossa informação cacheada o atender, iremos retorná-la e deduzir parte do custo.

Caso contrário, uma consulta em Tempo Real segue normalmente.

A ausência deste parâmetro irá configurá-lo com o valor mínimo de um dia.

Proteção Contra Serviço Indisponível

Para habilitar, adicione o parâmetro a seguir na requisição:

https://api.cnpja.com.br/companies/*CNPJ*?enable_cache_fallback=true

Por padrão, se algum problema ocorrer durante as consultas em Tempo Real, nossa API irá retornar os status de erro 500 ou 503.

Nestes casos, nenhum dado da empresa será retornado e sua aplicação deve gerenciar o tratamento da falha.

Porém, se o parâmetro enable_cache_fallback estiver habilitado, nosso serviço irá concluir a consulta com dados do Cache e retornar status 202.

O payload será idem ao padrão de sucesso 200, com adição de uma propriedade errors contendo uma matriz dos problemas.

A cobrança de créditos referente ao Tempo Real será deduzida da requisição.

Refira-se a documentação oficial para mais detalhes e exemplos deste cenário.