Rajapinta eli API

🔐 API-käyttö vaatii API-avaimen

Väärinkäytön estämiseksi API vaatii nyt API-avaimen ulkoisiin kutsuihin. Jos tarvitset API-käyttöä projektissasi, ole yhteydessä sähköpostitse saadaksesi henkilökohtaisen API-avaimen. Sivuston sisäinen toiminnallisuus jatkaa normaalia toimintaa.

https://mitatanaanliputetaan.vercel.app/ tarjoaa avoimen 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. 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äätepisteen 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

Palauttaa kuluvan päivän liputuspäivät. Jos liputuspäivää ei ole, palauttaa 404-vastauksen.

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: