Pular para o conteúdo principal

Consulta do protocolo

Guilherme Ganassin
Atualizado

Introdução

A consulta do protocolo é a segunda etapa do processo de consulta, e é onde o protocolo gerado na primeira etapa (Solicitação da Consulta) é consultado e o sistema obtém acesso ao retorno contendo as informações desejadas.

Se trata da segunda etapa do processo assíncrono que disponibiliza o resultado da consulta aos sistemas. Esta rota é assíncrona para que o mesmo protocolo possa ser consultado por diversas vezes, sem que haja novos custos.

 

Definições da requisição:

 

Método

GET

 

URL da API

   Homologação:

https://api.consultanegativacao.com.br/v2/homologacao/consultas/assincrona?protocolo=[protocolo]

   Produção:

https://api.consultanegativacao.com.br/v2/consultas/assincrona?protocolo=[protocolo]

Onde:

[protocolo] se trata do valor retornado no campo "protocolo" do JSON de resposta da solicitação da consulta.

 

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)
 cnpjUsuario

 CNPJ do usuário responsável pela consulta. 

 O CNPJ deve, obrigatoriamente, ter sido cadastrado pela rota de cadastro de empresas, descrito neste link.
 login

 Login de acesso disponibilizado pela SCC.

 O login será disponibilizado após a realização do cadastro da empresa, descrito neste link.
 password

 Senha de acesso disponibilizada pela SCC.

 A senha será disponibilizada após a realização do cadastro da empresa, descrito neste link.

 

 

Exemplo de Retorno

Status=200 - Sucesso

<style>
    #respostaLoad * {
        font-family: arial;
        font-size: 11px;
    }

    #respostaLoad .topo {
        background-color: #000;
        color: #FFF;
    }

    #respostaLoad .titulo {
        background-color: #ECF1F7;
        color: #1C4F90;
        border: 1px solid #d9e3e5;
        text-align: left;
        padding: 5px;
    }
 
...

 

Onde:

O retorno disponibilizado pela API em caso de sucesso é o HTML da consulta, contendo as informações do CPF/CNPJ desejado.

Como se trata de um HTML pronto, o resultado desta requisição pode ser utilizado livremente pelo sistema dos clientes, de acordo com a necessidade.

 

 

 

Status=202 - Em processamento

{
    "code": 202,
    "message": "Repita a consulta do protocolo em alguns segundos"
}

 

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 informa que o processamento ainda não foi concluído. Recomenda-se que se aguarde ao menos 5 segundos antes de repetir a consulta do mesmo protocolo.

 

 

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 - Protocolo não encontrado

{
    "code": 404,
    "message": "Protocolo não encontrado"
}

 

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 confirmar o protocolo obtido no JSON de resposta da solicitação da consulta.

 

 

 

 

Status=422 - Falha de processamento - Autenticação

{
    "code": 422,
    "message": "Unprocessable Entity",
    "errors": [
        {
            "message": "Campo cnpjusuario é obrigatório",
            "internalCode": 4001
        }
    ]
}

 

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
errors Objeto Lista de erros identificadas e que impossibilitaram o processamento da requisição
internalCode numérico

Código de erro interno

Obs.: Lista de erros em criação pela Tecnospeed
message string Mensagem de erro que orienta quanto ao problema. Neste caso, orienta-se que se verifique se todos os campos de autenticação (headers) estão preenchidos adequadamente.

 

 

 

 

 

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.