Após ser realizado o processo de solicitação de Consulta de Crédito, que vimos na etapa anterior, você receberá um protocolo referente à consulta efetuada.
Este protocolo você utilizará na rota GET que iremos apresentar nesta documentação, e o retorno desta consulta será um HTML com a resposta referente à consulta solicitada.
Definição de Requisição
A solicitação é feita através do método GET. A rota chamada deve ter a seguinte URL:
Homologação:
Produção:
Headers
| Nome | Descrição | Exemplo |
| cnpjSh | CNPJ da Software House que possui contrato com a Tecnospeed | 01001001000113 |
| tokenSh | Token da Software House que possui contrato com a Tecnospeed | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpjUsuario | CNPJ do cliente que está consultando | 01001001000113 |
QueryString
Exemplo:
https://api.consultanegativacao.com.br/v1/consultas/assincrona?protocolo=F6wVBwe4df
Retornos
Resultado em caso de sucesso:
- StatusCode 200:
HTML com o resultado da consulta
Caso opte por em vez de receber o HTML, receber um link direcionando para a consulta, basta adicionar o parâmetro link=true na URL da requisição.
Exemplo:
https://api.consultanegativacao.com.br/v1/consultas/assincrona?protocolo=aaaaaaaa&link=true
Utilizando a URL acima, a resposta será gerada no seguinte formato:
{
Obs.: O link gerado possuirá validade de 10 dias, a partir da data de geração.
- StatusCode 202:
Resultado em caso de "Consulta em processamento":
Quando a consulta retornar esta estrutura de resposta, basta aguardar alguns segundos (pelo menos 5) e efetuar novamente a consulta utilizando o mesmo protocolo!
- StatusCode 404:
Resultado em caso de erro:
- StatusCode 422:
Exemplo de erro quando os headers da requisição não forem informados:
Exemplo de erro quando o protocolo não for informado:
Obs.: As consultas são realizadas utilizando os serviços de consulta oferecidos pela SCC Check, parceira da Tecnospeed nas consultas.
Comentários
0 comentário
Por favor, entre para comentar.