Yleiset API-määritykset

Tietomuoto


  • Tietomuoto: application/json  tai text/json
  • Kaikki vastaukset ovat UTF-8-enkoodattuja.

HTTP-metodit


  • GET-rajapinnat voivat palauttaa joko yksittäisen kohteen tai kohdelistan (array).
  • PUT-rajapinnat voivat päivittää joko yksittäisen kohteen tai kohdelistan (array). Osa rajapinnoista luo automaattisesti uuden kohteen, jos annettua tunnistetta ei löydy.
  • POST-rajapinnat voivat luoda joko yksittäisen kohteen tai kohdelistan (array).
  • DELETE-rajapintojen kautta voi poistaa tietoja.

Päivämäärät ja ajat


Päivämäärä

YYYY-MM-DD

Päivämäärä ja aika aikavyöhykkeellä

YYYY-MM-DDTHH:mm:ss±HH:mm

Esimerkki:

2025-10-16T09:25:32+03:00

Vastaukset


Kaikki onnistuneet pyynnöt palauttavat HTTP-statuskoodin 200 OK.

Tyypillinen vastausrakenne:

{  "data": { ... } }

tai

{  "data": [ ... ] }

Kaikki onnistuneet pyynnöt palauttavat koodin 200 OK.

Virhetilanteissa palautetaan HTTP-statuskoodi ja virhekoodi.

Virherakenne

{
  "error": "ERROR_CODE",
  //optional, not returned for most errors
  "details": [ "OPTIONAL_DETAIL_1", "OPTIONAL_DETAIL_2", ... ]
}

Virhekoodit

HTTP-statuskoodi Virhekoodi Kuvaus
400 INVALID_ID Virheellinen tunniste
400 PARSE_ERROR Virheellinen muoto
400 INVALID_DATA Virheellinen sisältö
401 INVALID_CREDENTIALS Virheelliset tunnukset
403 UNAUTHORIZED Ei käyttöoikeutta
404 NOT_FOUND Resurssia ei löytynyt
429 RATE_LIMIT Liian monta pyyntöä
500 ERROR Odottamaton virhe

Rate limiting

  • Enintään 1000 pyyntöä tunnissa
  • Ylityksestä palautetaan HTTP-statuskoodi 429 Too Many Requests