Skip to main content

​
Estrutura da resposta

Em uma consulta concluída com sucesso (HTTP 200), a API devolve um objeto JSON com:
  • data: payload do produto para aquela consulta. Quando a origem devolve um envelope com array Result, a plataforma costuma expor o primeiro elemento como data (objeto único). Se a origem responder com sucesso e Result for um array vazio, data pode incluir Result, Status, QueryId, ElapsedMilliseconds, QueryDate e Evidences para não perder o contexto da consulta. Sem transformação no produto, pode ser o JSON bruto. Trate como estrutura orientada ao produto e valide apenas o que a integração utiliza.
  • meta: metadados da operação (sempre presentes em 200):
    • chargedCredits (string decimal): valor em R$ debitado nesta chamada.
    • product: slug do produto consultado (útil quando se usa a rota genérica POST /v1/query/{slug}).
    • queryId: identificador interno da consulta na Proteo (UUID do registro de auditoria). Informe este valor em chamados de suporte; não é o identificador da origem externa.

​
Cobrança

Cada resposta 200 debita créditos no valor aplicável ao produto, plano e volume do período. O valor efetivo da chamada aparece em meta.chargedCredits.

​
Boas práticas

Valide data conforme as suas regras de negócio e políticas de privacidade. Guarde meta.queryId quando precisar correlacionar logs do seu lado com o atendimento Proteo. A Referência da API descreve o contrato dos endpoints; o conteúdo de data continua dinâmico por produto e origem.