Introdução
A consulta do consumo é a rota pelo qual a Software House poderá consultar quantas consultas foram realizadas em determinado período, juntamente com o valor destas consultas e o valor de repasse.
Definições da requisição:
Método
GET
URL da API
Homologação:
https://homologacao.consultanegativacao.com.br/v2/consumo?inicio=2024-09-01&final=2024-09-30
Produção:
https://api.consultanegativacao.com.br/v2/consumo?inicio=2024-09-01&final=2024-09-30
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
{
"softwareHouse": {
"01001001000113": {
"total_softwarehouse": [
{
"valorTotal": "150.00",
"quantidade": 16,
"repasseSoftwareHouse": 7.50
}
],
"empresas": [
{
"cnpj": "11111111111111",
"valor": 100.00,
"quantidade": 15,
"repasseSoftwareHouse": 6.00,
"ultimaConsulta": "30/09/2024 02:36:33"
},
{
"cnpj": "22222222222222",
"valor": 50.00,
"quantidade": 1,
"repasseSoftwareHouse": 1.50,
"ultimaConsulta": "20/09/2024 07:38:51"
}
]
}
}
}
Onde:
| Campo | Tipo | Descrição |
|---|---|---|
| total_softwarehouse.valorTotal | string | Valor total das consultas disparadas pelos CNPJs vinculados à SH durante o período. |
| total_softwarehouse.quantidade | numérico | Quantidade total das consultas disparadas pelos CNPJs vinculados à SH durante o período. |
| total_softwarehouse.repasseSoftwareHouse | string |
Valor do repasse referente ao período pesquisado. Obs.: O valor varia de acordo com o modelo comercial e valor de venda das consultas. |
| empresas | array | Listagem das consultas separadas por CNPJ. |
| empresas.cnpj | string |
CNPJ responsável por realizar a consulta |
|
empresas.valor |
numérico |
Valor total das consultas disparadas pelo CNPJs durante o período. |
| empresas.quantidade | numérico | Quantidade total das consultas disparadas pelo CNPJ durante o período. |
| empresas.repasseSoftwareHouse | numérico | Valor do repasse referente ao período pesquisado. |
| empresas.ultimaConsulta | string | Data da última consulta realizada pelo CNPJ |
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. |
Status=422 - Falha de processamento - Filtro de data
{
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "Campo final é 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 os filtros de data da URL foram preenchidos corretamente. |
Comentários
0 comentário
Por favor, entre para comentar.