Documentazione API

Estrai dati stazione e aggregati con regole di fatturazione chiare.

L'API commerciale è pensata per richieste autenticate da account cliente. I buyer possono interrogare stazioni correnti, storico stazione o medie per brand, luogo, carburante e periodo.

AutenticazioneOgni pull commerciale usa una chiave API cliente legata a organizzazione e abbonamento.
QuotaLe risposte dati riuscite e fatturabili contano nel pacchetto mensile.
ProtezioneCopertura assente, parametri invalidi e storico non disponibile devono fallire prima della fatturazione.

Pattern di pull supportati

Pattern di pull supportati

L'API segue le domande tipiche dei clienti. Definizioni campi e contratti di risposta dettagliati sono condivisi privatamente dopo qualifica.

Riga stazione

Dati stazione per stazione o mercato filtrato.

Usa pull stazione per osservazioni correnti su stazione nota, città, CAP, paese o area.

Identificatore stazioneCittà o CAPPaese e carburanteArea delimitata

Storico

Storico stazione con controllo disponibilità.

Richiedi una finestra temporale. L'API deve confermare copertura prima di contare la richiesta.

Date inizio e fineStorico giornaliero recenteDisponibilità paeseStorico assente non fatturato

Aggregati

Prezzi medi per brand, luogo e tempo.

Usa aggregati per medie giornaliere o settimanali per brand, città, CAP, regione, paese o carburante.

Media brandMedia città o CAPMedia settimanale mercatoTrend paese

Come si fa una richiesta

Come si fa una richiesta

Le richieste commerciali usano HTTPS, chiave API, paese definito e filtri espliciti. Il contratto esatto è fornito nel portale dopo approvazione.

1Scegliere dati stazione o aggregati mercato.
2Fornire paese, carburante, filtri luogo o brand e periodo opzionale.
3Usare una prevalidazione per confermare copertura prima di un pull fatturabile.
4Solo risposte dati riuscite contano per quota o overage.

Sicurezza quota e fatturazione

Sicurezza quota e fatturazione

La regola target è semplice: il cliente paga l'accesso dati riuscito, non errori, mercati assenti o finestre storiche non supportate.

Conta nella quota

  • Richiesta autenticata restituisce dati stazione correnti.
  • Richiesta autenticata restituisce storico disponibile.
  • Richiesta autenticata restituisce aggregato per mercato e periodo supportati.

Non conta

  • Chiave API mancante o invalida.
  • Parametri invalidi o filtri non supportati.
  • Paese, città, stazione, brand o storico non disponibile.
  • Richiesta validata senza dati supportati.
  • Errore server prima di risposta dati utilizzabile.

Cosa resta da applicare nel layer API

Cosa resta da applicare nel layer API

Account, prezzi e checkout sono live. Il prossimo passo backend è validare chiavi API, contare uso e riportare overage a Stripe.

Chiavi API legate ai diritti organizzazioneContatori mensili per chiave e abbonamentoPrevalidazioni non fatturabiliOverage solo dopo quota inclusa
Vedi prezzi
Documentazione API carburante | Fuel Price Hub | Fuel Price Hub