Lovci Mrazov sprístupňujú meteorologické dáta cez API

od autora:

Projekt Lovci Mrazov rozširuje svoje možnosti o nové rozhranie API. Vybrané meteorologické údaje zo zapojených staníc je tak možné získavať v strojovo spracovateľnom formáte JSON a využívať ich vo vlastných aplikáciách, vizualizáciách, informačných systémoch alebo analytických projektoch.

Aké údaje API poskytuje

Prvá verzia API umožňuje:

  • získať zoznam dostupných meteorologických staníc,
  • načítať posledné meranie konkrétnej stanice,
  • načítať historické pozorovania za zvolené obdobie,

Aktuálne sú dostupné tieto endpointy:

GET /api/v1/stations
GET /api/v1/stations/{stationId}/latest
GET /api/v1/stations/{stationId}/observations

Odpovede sú poskytované vo formáte JSON. Jednotlivé merania obsahujú identifikáciu stanice, čas merania, teplotu a podľa typu stanice aj ďalšiu teplotnú hodnotu.

Prístup prostredníctvom API kľúča

API nie je úplne anonymné ani neobmedzené. Každý používateľ dostane vlastný API kľúč, pomocou ktorého sa identifikuje pri každej požiadavke.

Kľúč sa posiela v HTTP hlavičke:

Authorization: Bearer VÁŠ_API_KĽÚČ

Každému prístupu je možné nastaviť:

  • povolené meteorologické stanice,
  • maximálny počet požiadaviek za minútu,
  • denný limit požiadaviek,
  • dobu platnosti prístupu.

Takéto riešenie nám umožňuje chrániť databázu pred neprimeraným zaťažením a zároveň poskytovať údaje záujemcom, ktorí ich chcú používať zmysluplným spôsobom.

Interaktívna dokumentácia

Kompletná dokumentácia API je verejne dostupná prostredníctvom Swagger UI:

https://l.lovcimrazov.sk/api/docs

Dokumentácia obsahuje:

  • zoznam všetkých endpointov,
  • popis vstupných parametrov,
  • príklady JSON odpovedí,
  • chybové stavy,
  • informácie o autentifikácii,
  • možnosť API priamo otestovať.

Samotné meteorologické údaje zostávajú chránené API kľúčom. Verejný je iba technický opis rozhrania.

Pre koho je API určené

API môžu využiť napríklad:

  • vývojári webových a mobilných aplikácií,
  • prevádzkovatelia lokálnych informačných systémov,
  • meteorologickí nadšenci,
  • školy a študenti,
  • obce, organizácie alebo výskumné projekty,
  • tvorcovia grafov, máp a dátových vizualizácií.

Prístup prideľujeme individuálne podľa zamýšľaného spôsobu použitia.

Ako požiadať o prístup

Pri žiadosti nám, prosím, napíšte:

  • meno alebo názov organizácie,
  • účel využitia údajov,
  • ktoré stanice alebo lokality vás zaujímajú,
  • predpokladaný počet požiadaviek,
  • či budú údaje použité verejne alebo iba interne.

Kontaktovať nás môžete e-mailom na:

api@lovcimrazov.sk

Do predmetu správy uveďte:

Žiadosť o prístup k API – Lovci Mrazov

Po schválení vám vytvoríme samostatný API kľúč a nastavíme potrebné oprávnenia a limity.

Ďalší vývoj

Rozhranie API budeme ďalej rozširovať podľa reálneho využitia a spätnej väzby používateľov. Do budúcnosti zvažujeme najmä denné minimá a maximá, agregované údaje, prehľady dostupnosti staníc a ďalšie meteorologické veličiny.

Cieľom je sprístupniť údaje projektu Lovci Mrazov bezpečným, kontrolovaným a technicky použiteľným spôsobom.

Vložiť komentár