Tekninen kuvaus

Organisaationne voi käyttää Suomi.fi-viestien hyödyntämiseen useaa eri rajapintaa.

Pääsääntöisesti suosittelemme organisaatiotanne käyttämään Suomi.fi-viestien REST-rajapintaa. Lisäksi voitte käyttää POST-rajapintaa loppukäyttäjien asiointipalvelussanne täyttämien lomakkeiden välittämiseen Suomi.fi-viesteille. Muut rajapinnat ovat ylläpitotilassa, eikä niiden käyttämistä enää lähtökohtaisesti suositella. Näihin kuuluvat WS-, SFTP- ja SMTP-rajapinnat.

Jos organisaationne käyttää REST- tai POST-rajapintaa, liitytään Suomi.fi-viesteihin suoraliitynnän avulla. Muita rajapintoja käytettäessä organisaationne on tehtävä liityntä Valtion tieto- ja viestintätekniikkakeskus Valtorin Yhteisen integraatioalustan (VIA) kautta.

Voitte tutustua rajapintoihin yleisesti tällä sivulla ja tarkemmin erillisillä rajapintojen alasivuilla. Voitte vertailla rajapintoja tämän lisäksi Rajapintojen ominaisuusluettelon avulla.

REST on Suomi.fi-viestien rajapinnoista uusin ja monipuolisin. Kaikki Toiminnallisuudet-osiossa kuvatut toiminnallisuudet ovat käytettävissä REST-rajapinnassa.

Tiedonvälitys REST-rajapinnassa perustuu yksisuuntaiseen integraatioon, jossa organisaationne järjestelmä kutsuu Suomi.fi-viestejä käytetystä toiminnallisuudesta riippumatta.

Lukekaa lisää tästä rajapinnasta REST-rajapinta-sivulla.

POST-rajapinta mahdollistaa loppukäyttäjien asiointipalvelussanne täyttämien lomakkeiden tietojen välittämisen ja säilyttämisen Suomi.fi-viesteissä.

POST-rajapintaa käytetään ainoastaan lomakkeen tietojen siirtämiseen asiointipalvelustanne Suomi.fi-viesteille. Tietojen siirtäminen perustuu POST-kutsuihin. Vastaanottaaksenne lomakkeen sisällön Suomi.fi-viesteiltä täytyy organisaationne ottaa POST-rajapinnan lisäksi käyttöön toinen vastausmahdollisuutta tukeva rajapinta.

Lukekaa lisää tästä rajapinnasta POST-rajapinta-sivulla. Lisäksi voitte tutustua lomakkeiden vastaanottamiseen toiminnallisuutena Viestien vastaanottaminen -sivulla.

Yllä lueteltujen pääsääntöisten rajapintojen lisäksi Suomi.fi-viestien käyttäminen on mahdollista palvelun vanhempien rajapintojen avulla (WS, SFTP ja SMTP). Huomaattehan kuitenkin, että nämä rajapinnat ovat ylläpitotilassa, eikä niihin lähtökohtaisesti enää tuoteta uusia toiminnallisuuksia. Kaikki vanhat rajapinnat suljetaan 1.1.2027. Tämä tarkoittaa sitä, että kaikkien Suomi.fi-viestejä käyttävien palvelujen pitää siirtyä käyttämään uutta REST-rajapintaa ennen vuotta 2027.

Lukekaa lisää näistä rajapinnoista Vanhat rajapinnat -osiossa.

Päivitetty: 25.3.2025