Plein-moins-cher API
plein-moins-cher biedt een betaalde API waarmee u in realtime brandstofprijzen aangerekend door tankstations in Frankrijk kunt opvragen.
Gegevens met betrekking tot de gegevensstroom
De bron van de stroom is afkomstig van de overheidssite prix-carburants.gouv.fr, die bijna in realtime gegevens verstrekt over brandstofprijzen die door tankstations in Frankrijk worden aangerekend.
De feed is aangepast door plein-moins-cher om de dataset te verrijken met de namen en merken van tankstations (gegevens niet direct beschikbaar in de officiële feed).
Het debiet wordt ongeveer elke 10 minuten opnieuw berekend om zo getrouw mogelijk te zijn aan de prijsvariaties die tankstations een of meerdere keren per dag hanteren.
Grenzen van aansprakelijkheid
De prijsinformatie en de datum/tijd van update per brandstof, evenals de postadressen van de verkooppunten worden niet getransformeerd: ze worden geretourneerd zoals voorzien door de overheidssite.
De namen en merken van tankstations komen ook van de site van de overheid, maar komen niet uit de openbare feed.
Plein-Moss-Cher is niet verantwoordelijk voor mogelijke inconsistenties in deze informatie.
De breedtegraden/lengtegraden kunnen worden gecorrigeerd/aangepast door de goedkopere API omdat ze inconsistent of onnauwkeurig zijn.
plein-moins-cher is volledig afhankelijk van de Open Data-dienst van de overheidswebsite prix-carburants.gouv.fr.
Elke tijdelijke onbeschikbaarheid van de gegevensbron heeft invloed op de service die wordt geleverd door de goedkopere API: de laatst opgehaalde informatie wordt vervolgens geretourneerd door de API, in afwachting van de terugkeer van de service.
In het geval van een permanente stopzetting van de Open Data-service door de website prix-carburants.gouv.fr, zal de plein-moins-cher API de facto niet meer werken.
In dit geval wordt elk afgesloten abonnement afgesloten door plein-moins.cher.
De abonnee kan geen claim indienen.
Het gebruik van de API-service van plein-moins-cher impliceert aanvaarding van deze aansprakelijkheidsbeperkingen.
API-toegang
- De API is toegankelijk via een vaste URL, veilig en beschermd door een token (een token is een digitaal token).
- Toegang is onbeperkt in de tijd, de API kan op elk moment worden aangevraagd.
- Er wordt echter een glijdende maximumlimiet van 10 API-oproepen per minuut geactiveerd om de server te beschermen tegen kwaadaardig verkeer dat de werking ervan zou belemmeren.
- Een geldig token moet als parameter worden doorgegeven om de prijsinformatiestroom met betrekking tot alle stations te verkrijgen.
- Uw unieke en persoonlijke token wordt op verzoek per e-mail verstrekt aan pleinmoinscher@gmail.com
Token testen
- Met het test-token kunt u de API gratis testen.
- Het geretourneerde resultaat bevat echter een willekeurig maar exact spel beperkt tot 50 tankstations willekeurig geselecteerd uit de duizenden beschikbare stations.
Toegang tot test-API: https://api.geodateo.com/fuel/prices/v1?token=test
Licentie prijs
- Een uniek privé token wordt op verzoek verstrekt aan pleinmoinscher@gmail.com
- Deze token kan gratis voor 1 maand worden gebruikt, deze geldigheidslimiet wordt gedefinieerd vanaf de datum van het eerste gebruik van de token
via de API https://api.geodateo.com/fuel/prices/v1?token=<token>
- Er moet een licentie worden betaald om permanent van de service te kunnen profiteren.
- In geval van niet-abonnement van de licentie, wordt na 1 maand het verstrekte token gedeactiveerd.
Om een nieuw token te krijgen, moet een nieuwe aanvraag worden gedaan tegen volledig goedkoper.
Full-less-expensive behoudt zich dan het recht voor om al dan niet een nieuwe token uit te geven.
- De prijs van de licentie is vastgesteld op € 39/maand, te betalen door middel van een abonnement met een creditcard via het beveiligde Stripe-platform.
- De gebruiker kan zijn abonnement op elk moment stopzetten via zijn privé Stripe-factureringsportaal, waarvan de link per e-mail wordt verstrekt bij inschrijving.
- Elke beëindiging van het abonnement op initiatief van de abonnee deactiveert het token definitief.
- Het is aan de abonnee om dit token niet openbaar te maken.
- De abonnee kan dit token niet delen of onderbieden.
- Betaling wordt gedaan ten voordele van geodateo, uitgever van de website plein-moins-cher.fr
API abonneren
- 100% veilige betaling
- Prijs wordt maandelijks in rekening gebracht
- 100% transparant, geen verborgen kosten
- Je kunt je op elk moment uitschrijven
API-documentatie
Verzoek
Toegang tot de API is via de volgende URL:
https://api.geodateo.com/fuel/prices/v1?token=<token>&format=<format>&disposition=<disposition>
| Parameter |
Vereist |
Standaardwaarde |
Mogelijke waarden |
Beschrijving |
| token |
Ja |
- |
Uw persoonlijke sleutel, of "test" |
Uw persoonlijke identificatiesleutel |
| format |
Nee |
json |
json | csv | xl |
Geretourneerde indeling
json (JavaScript-objectnotatie): Web Data Interchange-indeling
csv (Comma-Separated Values): Excel-compatibele gegevensindeling waarbij gegevens worden gescheiden door puntkomma's
xls (Microsoft Excel): Excel-gegevensindeling
|
| disposition |
Nee |
inline |
inline | bijlage |
Wanneer de API wordt aangeroepen via een webbrowser (Chrome, Firefox, Edge), wordt bepaald of de inhoud wordt weergegeven op de pagina (inline) of wordt geretourneerd als een geüpload bestand (bijlage)
Opmerking: het "xls"-formaat legt de "attachment"-modus op.
|
Test met het "test"-token het verkregen resultaat: de API levert real-time prijsgegevens voor een willekeurige set van 50 stations.
URL's testen:
- Keer terug naar het json-formaat
https://api.geodateo.com/fuel/prices/v1?token=test&format=json
(met bestand bijgevoegd: https://api.geodateo.com/fuel/prices/v1?token=test&format=json&disposition=attachment)
- Keer terug naar csv formaat
https://api.geodateo.com/fuel/prices/v1?token=test&format=csv
- Keer terug naar het xls-formaat
https://api.geodateo.com/fuel/prices/v1?token=test&format=xls
Antwoord
Brandstofprijzen
De informatie wordt door het servicestation geretourneerd in het volgende formaat:
| Kenmerk |
Beschrijving |
Voorbeeld |
| brand |
Merk benzinestation |
Esso |
| name |
Naam van het tankstation |
Badplaats |
| postal_address |
Mailadres tankstation |
Rue de la Gare 14 |
| postal_code |
Postcode |
24100 |
| city |
Plaatsnaam |
Bergerac |
| department_code |
Afdelingscode |
24 |
| department_name |
Naam afdeling |
Dordogne |
| region |
Regionaam |
Nieuwe Aquitanië |
| latitude |
Geografische breedtegraad, tussen -90° en +90° |
44,8581250 |
| longitude |
Geografische lengtegraad, tussen -180° en +180° |
0,48215888 |
| gazole_price |
Dieselprijs, in Euro |
1.618 |
| gazole_update_date |
Datum/tijdstip update dieselprijs |
2023-07-04 19:10:05 |
| e85_price |
E85 ethanol prijs, in Euro |
1.049 |
| e85_update_date |
E85 Ethanol Prijs Update Datum/Tijd |
2023-07-04 09:31:03 |
| e10_price |
Prijs van Loodvrij 95-E10, in Euro |
1.784 |
| e10_update_date |
95-E10 Loodvrije prijs update datum/tijd |
2023-07-04 19:10:03 |
| sp95_price |
Prijs van Loodvrij 95, in Euro |
1.844 |
| sp95_update_date |
Datum/tijd bijwerken
van de prijs van Loodvrij 95 |
2023-07-04 19:22:13 |
| sp98_price |
Prijs van Loodvrij 98, in Euro |
1.774 |
| sp98_update_date |
Loodvrije 98 Prijs Update Datum/Tijd |
2023-07-04 18:18:15 |
| gplc_price |
LPG-prijs, in Euro |
1.884 |
| gplc_update_date |
LPG-prijs update datum/tijd |
2023-07-04 18:07:46 |
Opmerkingen:
- attributen in blauw worden mogelijk aangepast of gecorrigeerd door full-less-expensive,
- attributen in geel zijn toegevoegd door plein-cheaper (omdat ze niet aanwezig zijn in de officiële feed),
- de andere attributen komen rechtstreeks uit de overheidsstroom, ze worden niet getransformeerd.
format=csv
Retourneert een tabel met een koptekst waarvan de gegevens zijn gescheiden door puntkomma's
Voorbeeld:
https://api.geodateo.com/fuel/prices/v1?token=test&format=csv
Met bijgevoegd bestand:
https://api.geodateo.com/fuel/prices/v1?token=test&format=csv&disposition=attachment
format=xls
Retourneert een Microsoft Excel-compatibel bestand
Voorbeeld:
https://api.geodateo.com/fuel/prices/v1?token=test&format=xls
format=json
Retourneert een json-structuur die bevat:
| Kenmerk |
Beschrijving |
| date_generated |
Datum/Tijd van het genereren van de stream in JJJJ-MM-DD H24:MI:SS formaat, in TimeZone Europe/Paris. Bijv.: 15-07-2023 21:05:05 |
| items |
Een reeks objecten met informatie per tankstation |
| context |
"token": het gebruikte token,
"date_requested": datum/tijd van streamverzoek in JJJJ-MM-DD H24:MI:SS-formaat, in TimeZone Europe/Paris,
"originating_ip": het aanroepende IP,
"token_first_utilisation_date": de datum van het eerste gebruik,
"token_validity": de geldigheidsdatum (datum van eerste gebruik +1 maand) of "unlimited" in het geval van een betaalde licentie. |
Voorbeeld:
https://api.geodateo.com/fuel/prices/v1?token=test&format=json
Met bijgevoegd bestand:
https://api.geodateo.com/fuel/prices/v1?token=test&format=json&disposition=attachment
HTTP-antwoordcodes
Lijst met HTTP-antwoordcodes
| Code |
Beschrijving |
| 200 |
OK: verzoek is succesvol verwerkt, er wordt een resultaat geretourneerd. |
| 400 |
Onjuist verzoek: de URL of een van de parameters is ongeldig. |
| 401 |
Ongeautoriseerd: het gebruikte token is ongeldig. |
| 406 |
Niet acceptabel: de client moet de gzip-codering accepteren (Accept-Encoding:gzip moet aanwezig zijn in de kop van het verzoek). |
| 429 |
Te veel verzoeken: gebruikslimiet overschreden. Probeer het verzoek later opnieuw. |
| 500 |
Interne serverfout: er is een interne serverfout opgetreden. Probeer het verzoek later opnieuw. |
Belangrijke opmerking
De client moet het HTTP-verzoek verzenden met de header Accept-Encoding:gzip
Deze header wordt automatisch toegevoegd wanneer de API wordt opgevraagd via een webbrowser zoals Chrome, Firefox of Edge.
Aan de andere kant moet het expliciet worden gespecificeerd wanneer de API wordt aangeroepen vanaf de opdrachtregel met een tool zoals curl:
Bij afwezigheid wordt een retour met HTTP-code 406 (Niet acceptabel) gegenereerd.
API-aanroep, gevolgd door streamdecompressie:
curl -sH 'Accept-Encoding: gzip' https://api.geodateo.com/fuel/prices/v1?token=TEST | gunzip
