Documentation API

Récupérez données station et agrégats avec rÚgles de facturation claires.

L'API commerciale est conçue pour des requĂȘtes authentifiĂ©es par compte client. Les acheteurs peuvent interroger les stations courantes, l'historique station ou les moyennes par enseigne, lieu, carburant et pĂ©riode.

AuthentificationChaque pull commercial utilise une clé API client liée à une organisation et un abonnement.
QuotaLes réponses data réussies et facturables comptent dans le forfait mensuel inclus.
ProtectionCouverture absente, paramÚtres invalides et historique indisponible doivent échouer avant facturation.

Types de pulls supportés

Types de pulls supportés

L'API est organisée autour des questions habituelles des clients. Les définitions de champs et contrats de réponse détaillés restent privés aprÚs qualification.

Ligne station

Données station par station ou marché filtré.

Utilisez les pulls station pour des observations courantes par station connue, ville, code postal, pays ou zone.

Identifiant stationVille ou code postalPays et carburantZone géographique

Historique

Historique station avec vérification de disponibilité.

Demandez une pĂ©riode d'historique station. L'API doit confirmer la couverture avant de compter la requĂȘte.

Dates début et finHistorique quotidien récentDisponibilité paysHistorique absent non facturé

Agrégats

Prix moyens par enseigne, lieu et période.

Utilisez les agrégats pour moyennes quotidiennes ou hebdomadaires par enseigne, ville, code postal, région, pays ou carburant.

Moyenne enseigneMoyenne ville ou code postalMoyenne marché hebdomadaireTendance pays

Comment faire une requĂȘte

Comment faire une requĂȘte

Les requĂȘtes commerciales utilisent HTTPS, une clĂ© API, un pays cadrĂ© et des filtres explicites. Le contrat exact est fourni dans le portail client aprĂšs approbation.

1Choisir données station ou agrégats marché.
2Fournir pays, carburant, filtres lieu ou enseigne, et période optionnelle.
3Utiliser une prévalidation pour confirmer la couverture avant un pull facturable.
4Seules les réponses data réussies comptent dans le quota ou le dépassement.

Sécurité quota et facturation

Sécurité quota et facturation

La rĂšgle cible est simple: le client paie l'accĂšs data rĂ©ussi, pas les erreurs, marchĂ©s absents ou fenĂȘtres historiques non supportĂ©es.

Compte dans le quota

  • RequĂȘte authentifiĂ©e avec donnĂ©es station courantes.
  • RequĂȘte authentifiĂ©e avec historique station disponible.
  • RequĂȘte authentifiĂ©e avec agrĂ©gat pour marchĂ© et pĂ©riode supportĂ©s.

Ne compte pas

  • ClĂ© API absente ou invalide.
  • ParamĂštres invalides ou filtres non supportĂ©s.
  • Pays, ville, station, enseigne ou historique indisponible.
  • RequĂȘte validĂ©e sans donnĂ©e supportĂ©e pour le pĂ©rimĂštre demandĂ©.
  • Erreur serveur avant livraison d'une rĂ©ponse data utilisable.

Ce qui reste à appliquer cÎté API

Ce qui reste à appliquer cÎté API

Compte client, tarifs et checkout sont en ligne. La prochaine étape backend est de placer l'API commerciale derriÚre validation de clé, comptage d'usage et reporting Stripe.

Clés API liées aux droits organisationCompteurs mensuels par clé et abonnementPrévalidations non facturablesReporting dépassement aprÚs quota inclus
Voir les tarifs
Documentation API prix carburant | Fuel Price Hub | Fuel Price Hub