O processo de Consulta de Crédito é feito de forma assíncrona.
Ou seja, primeiro você utiliza esta rota POST para solicitar a consulta, e recebe um protocolo referente a este pedido;
E na sequência, em posse de seu protocolo, você utiliza a rota GET (que veremos no próximo post) para fazer a consulta e obter o HTML ou JSON com a resposta referente à Consulta de crédito solicitada.
Obs: Para obter o retorno em formato json é necessário preencher o parâmetro "retorno" com o valor "JSON".
Definição da Requisição
A solicitação é feita através de uma requisição POST. A rota chamada deve ter a seguinte URL:
Homologação:
https://api.consultanegativacao.com.br/v1/homologacao/consultas/assincrona
Produção:
https://api.consultanegativacao.com.br/v1/consultas/assincrona
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 | CdEZhJcQJS9rRdkLnx2Kl67GhAeBx89X2hzgVQ8i |
| cnpjUsuario | CNPJ do cliente que irá disparar as consultas | 01001001000113 |
| login | Login disponibilizado pela SCC Check após a assinatura do contrato | Ex.: Usuário01 |
| password | Senha disponibilizada pela SCC Check após a assinatura do contrato | Ex.: 123@mudar |
Body
json que deve ser enviado no body da requisição (como application/json)
{
"documento": "90472829000180",
"codConsulta": 4,
"uf": "PR",
"retorno": "JSON"
}
Definição dos campos:
| Campo | Obrigatório? | Descrição |
| documento | Sim | CNPJ ou CPF a ser consultado |
|
codConsulta |
Sim |
Código do tipo da consulta que será feita (clique aqui para visualizar os códigos de consulta disponíveis). |
|
uf |
Obrigatório para as consultas tipo 4 (CREDNET LIGHT + PROTESTO ESTADUAL para PF e PJ) e tipo 1 (CREDNET PF e PJ TOP) | Sigla da UF onde a consulta será feita (utilizada para obter informações de protesto estadual). Utilize apenas 2 dígitos. Exemplo: "PR" (clique aqui para visualizar a tabela com as siglas de todas as UFs) |
|
retorno |
Não (Necessário informar quando precisar do retorno no formato em json) | Valores aceitos ("JSON", "HTML"). (clique aqui para acessar o leiaute da consulta format json) |
Retornos
Em caso de sucesso:
- Status code 200:
Obs.: Ao receber um statusCode 200 na requisição, é de extrema importância que o protocolo retornado seja salvo, pois o resultado da consulta na próxima requisição depende inteiramente da consulta deste protocolo.
Definição dos campos em caso de sucesso:
| Campo | Descrição |
| protocolo | Valor a ser persistido e que deve ser utilizado na próxima consulta |
|
status |
Situação da requisição. Pode assumir um dos seguintes valores: Produção: processando Homologação: homologacao_processando |
|
documento |
CPF ou CNPJ consultado |
|
codConsulta |
Tipo da consulta informado no json de envio |
Em caso de erro:
- StatusCode: 422
Exemplo de erro quando informado o campo "codConsulta" com um valor não aceito:
Exemplo de erro quando os headers da requisição não forem informados:
Exemplo de erro quando informado um CPF ou CNPJ inválido:
Exemplo de erro quando informado uma UF incorreta:
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "Campo uf deve ser igual a um dos valores predefinidos: AC,AL,AM,AP,BA,CE,DF,ES,GO,MA,MT,MS,MG,PA,PB,PR,PE,PI,RJ,RN,RO,RS,RR,SC,SE,SP,TO",
"internalCode": 4003
}
]
}
Exemplo de erro quando não for informado um campo obrigatório:
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "Campo documento é obrigatório",
"internalCode": 4001
}
]
}
Nos retornos acima, o objeto "errors" trará a listagem de erros que poderão ter ocorrido na solicitação da consulta. E o campo "message" trará uma mensagem informando o motivo do erro.
Em caso de sucesso e com o protocolo em mãos é hora de entendermos a rota de consulta deste protocolo. No próximo passo esta implementação será definida!
Obs.: As consultas são realizadas utilizando os serviços de consulta oferecidos pela SCC Check, parceira da Tecnospeed nas consultas.
Feito com amor pela Comunicação
Comentários
0 comentário
Por favor, entre para comentar.