Rajapinta

Saunotaanko.fi sivustolla on yksinkertainen rajapinta minkä kautta saa haettua saunotaanko tänään vaiko ei.

Rajapinta ei vaadi tällä hetkellä tunnistautumista. Rajapinta on myös ilmainen käyttää.

Rajapinta on hyvin yksinkertainen ja voi sisältää jotain pieniä bugeja ja hassuuksia. Näistä voi ilmoittaa osoitteeseen [email protected].

Mikäli käytät rajapintaa olisi hauska tietää myös mihin tarkoitukseen. Voit siis halutessasi pistää sähköpostia käyttötarkoituksestasi!

Endpointit

Alla on listattu mitä endpointteja on käytössä.

Saunotaanko tänään

Tämä kertoo ainakin kulloisen päivän tilanteen.

GET: https://saunotaanko.fi/api/v1/today/{hour1?}/{hour2?}/{maxprice?}

Parametrit:

• hour1: ensimmäisen tunnin saunan kulutus (valinnainen)
• hour2: toisen tunnin saunan kulutus (valinnainen)
• maxprice: maksimihinta saunomiselle (valinnainen)

Palautus

Rajapinta palauttaa jsonina kuluvan päivän tiedon siitä saunotaanko tänään vai ei. Samoin palautetaan aikavälien hinnat euroina ja saunotaanko tila.

Rajapinta näyttää myös käytetyt säännöt.

• saunotaanko: boolean (true/false)
• price: numeerinen

{
    "saunotaanko": true,
    "times": {
        "16:00 – 17:59": {
            "saunotaanko": true,
            "price": 0.3665
        },
        "17:00 – 18:59": {
            "saunotaanko": true,
            "price": 0.3718
        },
        "18:00 – 19:59": {
            "saunotaanko": true,
            "price": 0.3817
        },
        "19:00 – 20:59": {
            "saunotaanko": true,
            "price": 0.3901
        },
        "20:00 – 21:59": {
            "saunotaanko": true,
            "price": 0.3846
        }
    }
    "rules": {
        "hour1": 5,
        "hour2": 4,
        "maxprice": 0.9
    }
}

Esimerkkejä

Tämä esimerkki hakee suoraan sivuston käyttämin oletushinnoin saunotaanko tänään vai ei:

GET: https://saunotaanko.fi/api/v1/today

Tämä esimerkki hakee saunotaanko jos

• Ensimmäisen tunnin kulutus on 6 kWh
• Toisen tunnin kulutus on 5 kWh
• Maksimi hyväksytty saunomisen hinta on 1.2 €

GET: https://saunotaanko.fi/api/v1/today/6/5/1.2

Rajapintaa päivitetty 26.6.2024.

Etusivulle