Rajapinta eli API

🔐 API-käyttö vaatii API-avaimen

Väärinkäytön estämiseksi useimmat rajapinnan päätepisteet vaativat API-avaimen ulkoisiin kutsuihin. Poikkeuksena GET /api/liputuspaivat/today on julkinen ilman avainta (esim. e-ink-näytöt ja yksinkertaiset HTTP-pollerit). Muut päätepisteet (/api/liputuspaivat, thisWeek, thisMonth) vaativat edelleen avaimen. Jos tarvitset laajempaa API-käyttöä, ole yhteydessä sähköpostitse saadaksesi henkilökohtaisen API-avaimen.

https://mitatanaanliputetaan.vercel.app/ tarjoaa rajapinnan Suomen liputuspäivädataan.

API-dokumentaatio

Yleistä

Kaikki API-kutsut palauttavat JSON-muotoisen vastauksen. Ulkoiset kutsut vaativat API-avaimen HTTP-headerissa. Jokainen liputuspäivä sisältää seuraavat kentät:

  • name - Liputuspäivän nimi
  • date - Päivämäärä ISO-muodossa
  • description - Kuvaus liputuspäivästä
  • official - Boolean-arvo, joka kertoo onko kyseessä virallinen liputuspäivä
  • links - Lista linkkejä lisätietoihin

Autentikointi

Ulkoiset API-kutsut vaativat API-avaimen, paitsi julkinen GET /api/liputuspaivat/today. Muille päätepisteille lähetä avain joko:

  • X-API-Key headerissa
  • Authorization: Bearer your-api-key headerissa

Esimerkki cURL-kutsusta:

curl -H "X-API-Key: your-api-key" https://mitatanaanliputetaan.vercel.app/api/liputuspaivat

Päätepisteiden tiedot

Kaikki liputuspäivät

GET /api/liputuspaivat

Palauttaa kaikki liputuspäivät ja niiden lukumäärän.

Tämän päivän liputuspäivät

GET /api/liputuspaivat/today

Julkinen päätepiste (ei API-avainta). Palauttaa kuluvan päivän liputuspäivät Suomen aikavyöhykkeessä (Europe/Helsinki). Jos liputuspäivää ei ole, palauttaa HTTP 200 ja tyhjän data-taulukon sekä viestin Tänään ei ole liputuspäivä.

curl https://mitatanaanliputetaan.vercel.app/api/liputuspaivat/today

Tämän viikon liputuspäivät

GET /api/liputuspaivat/thisWeek

Palauttaa kuluvan viikon (ma-su) liputuspäivät ja viikon päivämäärävälin.

Tämän kuukauden liputuspäivät

GET /api/liputuspaivat/thisMonth

Palauttaa kuluvan kuukauden liputuspäivät ja kuukauden nimen.

Kokeile API:a

Klikkaa alla olevia linkkejä nähdäksesi API-vastaukset:

  • Kaikki liputuspäivät:

  • Kuluvan viikon liputuspäivät:

  • Kuluvan kuun liputuspäivät:

  • Kuluvan päivän liputuspäivät: