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

Luo laadukas käyttöönottoprosessi

Anna palvelutasolupaus

Ohjelmointirajapintojen tarjoaminen ja hyödyntäminen luovat riippuvuussuhteita. Ohjelmointirajapinnan palvelutasolupaus (Service-Level Agreement, SLA) kuvaa ohjelmointirajapinnan hyödyntämisen aikaiset reunaehdot. Huomioi, että jokaisen käytetyn ohjelmointirajapinnan palvelutasoon liittyy asiakasodotuksia, vaikka palvelutasolupausta ei olisi edes määritelty.

Väärin toteutettuna ohjelmointirajapinnan hallinta voi muodostaa merkittävän esteen sen hyödyntämiselle. Avoimen ohjelmointirajapinnan käyttöönottoa ja käyttöä rajoitetaan käytännössä lähes aina jollain tavalla.

Käytännössä ohjelmointirajapinnan palvelutasoa hallitaan API gatewayn avulla. Siihen asetetaan usein palvelutasoon liittyviä sääntöjä ja ehtoja. Esimerkiksi kyselyiden kokonaismäärää voidaan rajoittaa tai osaa hyödyntäjien kyselyistä priorisoidaan. On tärkeää viestiä näistä ohjelmointirajapinnan hyödyntäjille, jotta heidän odotuksensa ohjelmointirajapinnan toiminnan suhteen ovat realistisia.

Jos ohjelmointirajapinnan palvelutasoa ei ole viestitty mitenkään, on sen hyödyntäminen riski, jota hyödyntäjä ei pysty arvioimaan. Hyödyntäjän näkökulmasta ohjelmointirajapinta voisi teoriassa lopettaa toimintansa koska tahansa.

Päivitetty: 5.5.2026

Perustele rajoitukset ja viesti selkeästi

Hyvässä käyttöönottoprosessissa rajoitukset viestitään ja perustellaan avoimesti

  • ohjelmointirajapinnan hyödyntämistä suunnittelevalle
  • osana käyttöönottoprosessia
  • osana hyödyntämisen aikaista palvelutasolupausta.

Käytännön esimerkki heikosta ohjelmointirajapinnan käyttöönottoprosessissa on sellainen, missä käyttölupapyyntö lähetetään paperilomakkeilla virastoon, joka voi sitten käsitellä sitä kuukausia. Kun käsittelyn läpimenoaikaa on mahdoton arvioida, voi tärkeä hanke tai projekti viivästyä.

Sääntely voi toki asettaa reunaehtoja siihen, miten paljon prosessia voi automatisoida.

Kannattaa tavoitella prosessin selkeää viestintään ja kuvaamista.

Mieti

  • millainen asiakaskokemus hyödyntäjälle syntyy
  • miltä käyttöönottoprosessi hyödyntäjästä näyttää.
Päivitetty: 5.5.2026

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

Sanasto