Suomi.fi kehittäjille
Siirry suoraan sisältöön.
Hyvät käytännöt kehittäjille
Ohjelmointirajapintojen suunnittelu julkisessa hallinnossa

Hallitse prosesseja kohderyhmäajattelun avulla

Jäsennä ohjelmointirajapinnan hyödyntäjät

Ohjelmointirajapinnat ovat tärkeitä niin organisaation sisäisessä kuin ulkoisessa käytössä. Organisaatiot tuottavat omia ohjelmointirajapintojaan ja hyödyntävät muiden organisaatioiden ohjelmointirajapintoja eri tarkoituksiin.

Ohjelmointirajapintojen käytön voi jäsentää kehiksi:

  • Sisimmässä kehässä ovat tietojärjestelmän omat sisäiset ohjelmointirajapinnat, joita on määrällisesti eniten ja joita käytetään eniten.
  • Sisimmän kehän ympärille voidaan piirtää uusia kehiä: mitä kauemmas ytimestä siirrytään, sitä rajatumman näkymän ohjelmointirajapinnat tarjoavat tietojärjestelmään ja sitä etäämmällä ne ovat tietojärjestelmän tilaajasta.

Ohjelmointirajapinnan sisäiset ja ulkoiset hyödyntäjät.

Päivitetty: 8.5.2026

Sisäiset ohjelmointirajapinnat

Tietojärjestelmän tai laajemmin organisaation sisäiseen käyttöön tarkoitettujen ohjelmointirajapintojen arvo on merkittävä organisaatioissa. Ne ovat yleensä yleisimpiä ja käytetyimpiä, mutta eivät näy organisaation ulkopuolelle.

Sisäisten rajapintojen toteuttaminen on usein teknisesti ja hallinnollisesti yksinkertaisempaa kuin ulkoisten ohjelmointirajapintojen. Ne voivat olla räätälöityjä tietyn tietojärjestelmän erityistarpeisiin.

Laajan sisäisten ohjelmointirajapintojen verkoston luominen helpottaa tulevaa kehitystyötä ja mahdollistaa palvelujen ulkoisen avaamisen tarvittaessa. Organisaation eri osat voivat käyttää samoja, aiemmin testattuja toimintoja. Esimerkiksi Amazonin API ensin -malli on ollut tärkeä osa sen menestystä.

Päivitetty: 12.5.2026

Ulkoiset ohjelmointirajapinnat

Ulkoisia ohjelmointirajapintoja käytetään yhteistyöhön sekä julkisen hallinnon organisaatioiden että yksityisen sektorin kanssa. Asiakaslähtöinen suunnittelu on tärkeää näiden ohjelmointirajapintojen kehittämisessä, jotta ne vastaavat käyttäjien tarpeisiin ja tuottavat arvoa organisaation ulkopuolisille toimijoille. Asiakastarpeiden ymmärtämiseksi kannattaa haastatella ja havainnoida käyttäjiä.

Ohjelmointirajapintoihin tutustuessa on hyvä huomata, että osa kutsuu vain tietojärjestelmän ulkoisia ohjelmointirajapintoja "ohjelmointirajapinnoiksi". Tämä on ymmärrettävää, sillä monet käyttötapaukset edellyttävät ulkoisia ohjelmointirajapintoja ja näiden kehittämiseen liittyy vaatimuksia, joita sisäisillä ohjelmointirajapinnoilla ei ole.

Päivitetty: 6.5.2026

Oletko tyytyväinen tämän sivun sisältöön?

Sanasto