Empresômetro - API

Token


Para que você possa integrar seu sistema e fazer consultas de empresas na base do Empresômetro você precisará de um token.

Esse token é individual por conta, e será a sua identificação para que sua conta possa fazer uso da API. Toda consulta deverá conter o token no header da requisição.

Você pode solicitar esse token através do e-mail contato@empresometro.com.br, do telefone (41)2117-7300 ou Clique aqui e entre em contato

Método - Empresa


Requisição

Todas as requisições devem conter obrigatóriamente o número do CNPJ que está sendo solicitado e o Token no Header da requisição.

O cliente tem a opção de solicitar o Telefone, E-mail, Quadro Societário, Faixa de Funcionários, Porte, Quantidade de Filiais, Faixa de Faturamento e/ou o (exclusivo) Indicador de Atividade Empresarial através de parametros informados na URL.

Request
Post https://api.empresometro.com.br/api/v1.1/empresa/123456789000109?telefone=true&email=true&socio=true&faixaFuncionario=true&porte=true&quantidadeFiliais=true&faixaFaturamento=true&indicadorAtividadeEmpresarial=true Header Content-Type: application/json Accept: application/json Token: f3f26e56-3544-4bbf-a475-2ea442fd7fdd
Resposta

Uma requisição bem sucedida terá como retorno os nós Empresa e Requisição.

O nó empresa agrupa as informações da empresa encontrada.

O nó requisição contém a identificação da requisição e o status da mesma.

Response
Code 200 Header Content-Type: application/json Accept: application/json
Body
[ { "Empresa": [ { "CNPJ": "123456789000109", "RazaoSocial": "EMPRESA BRASILEIRA", "NomeFantasia": "EMPRESA BRASILEIRA", "Regulamentacao": "MATRIZ", "SimplesNacional": "NÃO", "SIMEI": "NÃO", "InscricaoEstadual": "REGULAR", "NaturezaJuridica": "ASSOCIAÇÃO PRIVADA", "SituacaoCadastral": "ATIVA", "SituacaoEspecial": "RECUPERACAO JUDICIAL", "DataSituacaoCadastral": "2018-01-01", "DataAbertura": "2018-01-01", "Idade": 1, "Endereco": "AVENIDA KENNEDY", "Numero": "123", "Complemento": "SALA: 1A", "CEP": "12345678", "Bairro": "PARQUE EMPRESARIAL", "Cidade": "MORRO AZUL", "Estado": "SAO PAULO", "Regiao": "SUDESTE", "Mesorregiao": "METROPOLITANA DE SAO PAULO", "Microrregiao": "SAO PAULO", "Latitude": -10.00000000000000000000, "Longitude": -10.00000000000000000000, "CidadePopulacao": 1234567, "Setor": "SERVIÇOS", "CapitalSocial": 123456.00, "CNAEPrimario": [ { "Codigo": "111301", "Descricao": "CULTIVO DE ARROZ" } ], "CNAESecundarios": [ { "Codigo": "0500301", "Descricao": "EXTRACAO DE CARVAO MINERAL" }, { "Codigo": "1811301", "Descricao": "IMPRESSAO DE JORNAIS" } ], "Telefones": [ { "DDD": "11", "Numero": "99999999" }, { "DDD": "41", "Numero": "88888888" } ], "Emails": [ { "Endereco": "email_comercial@email.com.br", "Dominio": "email.com.br" }, { "Endereco": "email_gerente@email.com.br", "Dominio": "email.com.br" } ], "Socios": [ { "Nome": "ANA CLARA", "Qualificacao": "22 - Sócio" }, { "Nome": "GABRIELA PONTES", "Qualificacao": "22 - Sócio" } ] "Porte": "MÉDIA EMPRESA", "FaixaFaturamento": "8.000.000 ATÉ 9.000.000", "FaixaFuncionario": "FAIXA DE 21 A 50 FUNCIONÁRIOS", "QuantidadeFiliais": 3, "IndicadorAtividadeEmpresarial": "SIM", } ], "Requisicao": [ { "Identificacao": "ecc22522-e3e1-4119-997d-7aab1f083aa9", "Status": 9 "CustoCredito": 95 } ] } ]

Requisições mal sucedidas terão como resposta apenas o nó Requisição.

Response
Ausência de informação obrigatória (CNPJ e/ou Token). Code 400 Header Content-Type: application/json Accept: application/json
Body
[ { "Requisicao": [ { "Identificacao": "bddcd127-954f-4897-8cf4-65a590ef0c14", "Status": 5 } ] } ]

Caso seus créditos terminem suas requisições retornarão 402 como código de retorno (return code) e status 2 dentro do nó Requisição.

Response
Créditos insuficientes. Code 402 Header Content-Type: application/json Accept: application/json
Body
[ { "Requisicao": [ { "Identificacao": "c704e526-3697-4323-9b20-6c52640a3c88", "Status": 2 } ] } ]

Certifique-se de utilizar um token válido criado pela equipe do Empresômetro. Caso seu token não seja identificado ou esteja inativo sua requisição terá como retorno o código 403 e acompanhado do status 1.

Response
Token inválido ou desconhecido. Code 403 Header Content-Type: application/json Accept: application/json
Body
[ { "Requisicao": [ { "Identificacao": "d7b41381-44c6-4c8b-bc8a-597dfb3dadbc", "Status": 1 } ] } ]

Em caso de erro interno o código de retorno será o 500 e o status da requisição será o 20.

Response
Erro interno Code 500 Header Content-Type: application/json Accept: application/json
Body
[ { "Requisicao": [ { "Identificacao": "09483cbd-dd6b-49cd-bed6-aed89bf025ae", "Status": 20 } ] } ]

Método - Saldo de crédito


Requisição

Todas as requisições devem conter obrigatóriamente o Token no Header da requisição.

Request
Post https://api.empresometro.com.br/api/v1.1/saldocredito/ Header Content-Type: application/json Accept: application/json Token: f3f26e56-3544-4bbf-a475-2ea442fd7fdd

Com isso é possível acompanhar a quantidade de créditos que sua conta possui.

Response
Code 200 Header Content-Type: application/json Accept: application/json
Body
[ { "SaldoCredito": 123456, "Requisicao": [ { "Identificacao": "b08d03d2-9935-4e1a-8f2f-372474541811", "Status": 9 "CustoCredito": 0 } ] } ]

Endpoint


Ambiente Endpoint Token
Produção https://api.empresometro.com.br/api/v1.1/ Entre em contato

Custo por informação


Informação Créditos
Dados básicos 10 créditos
Telefone 7 créditos
E-mail 7 créditos
Sócios 7 créditos
Porte 7 créditos
Faixa de funcionário 10 créditos
Faixa de faturamento 20 créditos
Quantidade de filiais 7 créditos
Indicador atividade empresarial 20 créditos
Total 95 créditos

Código de retorno


Código Nome Descrição
200 OK Sucesso
400 Bad Request Algum campo obrigatório não foi enviado ou foi enviado de maneira incorreta
402 PaymentRequired Créditos insuficientes
403 Forbidden Token inválido ou desconhecido
404 Not Found Recurso não encontrado
500 Internal Server Error Erro interno

Status


Código Descrição
0 Status inicial
1 Token inválido ou desconhecido
2 Créditos insuficientes
5 CNPJ Inválido
6 CNPJ não encontrado
9 Sucesso
20 Erro interno

Protocolos


Protocolos aceitos Descrição
TLS 1.2 Obrigatório

Simulação


Utilize os CNPJs abaixo para validar retornos específicos.

CNPJ para sandbox Status retornado Descrição
22222222222259 2 Créditos insuficientes
55555555555576 5 CNPJ Inválido
66666666666645 6 CNPJ não encontrado