Documentação API

Extraia dados por posto e agregados com regras claras de faturação.

A API comercial foi pensada para pedidos autenticados por conta cliente. Compradores podem consultar postos atuais, histórico por posto ou médias por marca, localização, combustível e período.

AutenticaçãoCada extração comercial usa uma chave API ligada a organização e subscrição.
QuotaRespostas de dados bem-sucedidas e faturáveis contam no pacote mensal.
ProteçãoCobertura ausente, parâmetros inválidos e histórico indisponível devem falhar antes da faturação.

Padrões de extração suportados

Padrões de extração suportados

A API organiza-se pelas perguntas habituais dos clientes. Definições de campos e contratos detalhados são partilhados em privado após qualificação.

Linha posto

Dados por posto ou mercado filtrado.

Use extrações por posto para observações atuais por posto conhecido, cidade, código postal, país ou zona.

Identificador do postoCidade ou código postalPaís e combustívelZona delimitada

Histórico

Histórico por posto com verificação de disponibilidade.

Peça uma janela temporal. A API deve confirmar cobertura antes de contar o pedido.

Datas de início e fimHistórico diário recenteDisponibilidade por paísHistórico indisponível sem cobrança

Agregados

Preços médios por marca, localização e tempo.

Use agregados para médias diárias ou semanais por marca, cidade, código postal, região, país ou combustível.

Média por marcaMédia por cidade ou código postalMédia semanal de mercadoTendência país

Como fazer um pedido

Como fazer um pedido

Pedidos comerciais usam HTTPS, chave API, país definido e filtros explícitos. O contrato exato é fornecido no portal após aprovação.

1Escolher dados por posto ou agregados de mercado.
2Enviar país, combustível, filtros de localização ou marca e período opcional.
3Usar validação prévia para confirmar cobertura antes de extração faturável.
4Só respostas de dados bem-sucedidas contam para quota ou excesso.

Segurança de quota e faturação

Segurança de quota e faturação

A regra alvo é simples: o cliente paga por acesso a dados bem-sucedido, não por erros, mercados ausentes ou histórico não suportado.

Conta na quota

  • Pedido autenticado devolve dados atuais por posto.
  • Pedido autenticado devolve histórico disponível.
  • Pedido autenticado devolve agregado para mercado e período suportados.

Não conta

  • Chave API ausente ou inválida.
  • Parâmetros inválidos ou filtros não suportados.
  • País, cidade, posto, marca ou histórico indisponível.
  • Pedido validado sem dados suportados.
  • Falha servidor antes de resposta utilizável.

O que falta aplicar na camada API

O que falta aplicar na camada API

Conta, preços e checkout estão online. O próximo passo backend é validar chaves API, contar uso e reportar excesso ao Stripe.

Chaves API ligadas a direitos da organizaçãoContadores mensais por chave e subscriçãoPré-validações não faturáveisReporte de excesso só após quota incluída
Ver preços
Documentação API de combustível | Fuel Price Hub | Fuel Price Hub