Pular para o conteúdo principal

Consultar Empresas Cadastradas

Guilherme Ganassin
Atualizado

Introdução

A consulta das empresas cadastradas é a rota pelo qual a Software House poderá consultar todos os CNPJs cadastrados e vinculados a ela, separando por CNPJs ativos e inativos.

 

Definições da requisição:

 

Método

GET

 

URL da API

   Homologação:

https://api.consultanegativacao.com.br/v2/homologacao/consumo/empresas

   Produção:

https://api.consultanegativacao.com.br/v2/consumo/empresas

 

 

Headers

Os headers necessários para a autenticação da requisição são:

 Header  Descrição
 cnpjsh  CNPJ da Software House que possui contrato com a Tecnospeed
 tokensh  Token de autenticação da Software House (obtido através deste processo)

 

 

Exemplo de Retorno

Status=200 - Sucesso

[
    {
        "desativado": false,
        "cadastros": [
            {
                "nomeFantasia": "TESTE EMPRESA 1",
                "cnpj": "11111111111111"
            },
            {
                "nomeFantasia": "TESTE EMPRESA 2",
                "cnpj": "22222222222222"
            }
        ]
    },
    {
        "desativado": true,
        "cadastros": [
            {
                "nomeFantasia": "TESTE EMPRESA 3",
                "cnpj": "33333333333333"
            }
        ]
    }
]

 

Onde:

Campo Tipo Descrição
 desativado  booleano
  •  false: Identifica CNPJs que não foram desativados, portanto, encontram-se ATIVOS;
  • true: Identifica CNPJs que foram desativados, portanto, encontram-se INATIVOS.
     
 cadastros  array  
 cadastros.nomeFantasia  string   Nome Fantasia do cadastro
 cadastros.cnpj  string   CNPJ Cadastrado

 

 

Status=401 - Falta de autorização

{
    "code": 401,
    "message": "CNPJ ou TOKEN incorretos, verifique sua conta em https://conta.tecnospeed.com.br"
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string  Mensagem de erro que orienta quanto ao problema. Neste caso, recomenda-se a validação das credenciais de autenticação da rota

 

 

Status=404 - Rota não encontrada

{
    "code": 404,
    "message": "Rota não encontrada, verifique a rota informada"
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string  Mensagem de erro que orienta quanto ao problema. Neste caso, recomenda-se verificar se a URL está preenchida adequadamete.

 

 

 

 

 

 

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.