Regras de contabilização de consulta
Simples, previsível e totalmente transparente.
De forma geral, a Plataforma de Dados da BigDataCorp adota o princípio de 1 consulta = 1 cobrança. Sempre que uma requisição é processada com sucesso, a consulta é contabilizada independentemente da quantidade de dados retornados.
Em alguns cenários, a consulta pode ser contabilizada mesmo quando o retorno não contém as informações esperadas. Isso acontece porque, em determinados casos, a própria ausência de dados ou a validação realizada pela API já constitui uma resposta válida para a consulta efetuada.
A tabela abaixo resume os principais cenários em que uma consulta pode ou não ser contabilizada durante o processamento das requisições na Plataforma de Dados.
| Cenário | Cobrança | Observação |
|---|---|---|
| Documento inválido | Sim | A API retorna que o documento informado é inválido |
| Menor de idade | Sim | A consulta retorna que o documento pertence a um menor |
| Timeout inferior a 5 minutos | Sim | A consulta permanece em processamento pela plataforma |
| Timeout da fonte externa | Não | Retorna erro "DATASET IS TOO SLOW" |
| Consulta sem retorno de dados | Sim | A ausência de dados também constitui resposta válida |
| Erro 504 | Não | A requisição não chega a ser processada pela plataforma |
Detalhamento dos cenários:
A consulta é contabilizada quando a API identifica que o documento informado é inválido. Nesses casos, o retorno é acompanhado do código -114 — INVALID DOC PARAMETER, que representa uma resposta válida da plataforma.
Consultas relacionadas a menores de idade também são contabilizadas, pois a identificação dessa condição faz parte do resultado da consulta. Nesses casos, é cobrado apenas o valor referente ao dataset Dados Cadastrais Básicos. Saiba mais →
Quando uma consulta ultrapassa o tempo esperado de resposta, mas permanece em processamento pela plataforma por até cinco minutos, ela continua sendo considerada uma consulta válida e pode ser contabilizada normalmente.
O erro DATASET IS TOO SLOW indica lentidão ou indisponibilidade da fonte externa consultada. Como a resposta não pôde ser obtida junto à fonte, a consulta não é contabilizada.
Em determinados datasets, a ausência de dados também representa um resultado válido da consulta realizada e, portanto, pode ser contabilizada normalmente. Como essa regra pode variar entre datasets, recomendamos consultar a documentação específica de cada um deles.
O erro HTTP 504 normalmente está relacionado à infraestrutura de rede entre o sistema do cliente e a Plataforma de Dados. Como a requisição não chega a ser processada pela plataforma, a consulta não é contabilizada.
Updated 9 days ago