suomi.fi
Siirry suoraan sisältöön.
Kehittäjän opas

Palveluväylän palveluiden käyttöönotto

Saat parhaat ohjeet tilanteeseesi, kun vastaat ensin kysymyksiin Esikysymykset-sivulla.

Tutustu Suomi.fi-palveluväylään

Mikä on Suomi.fi-palveluväylä?

Suomi.fi-palveluväylä on palvelu, jonka avulla eri organisaatiot voivat siirtää tietoa toistensa järjestelmien välillä tietoturvallisesti. Organisaatiot voivat

  • hyödyntää toistensa tarjoamia palveluita ja tietovarantoja
  • tarjota omia palveluitaan muiden käyttöön.

Palvelun tuottaa Digi- ja väestötietovirasto.

Päivitetty: 19.1.2024

Palveluväylän käyttöönottoprosessi

Suomi.fi-palveluväylän käyttöönotto on monivaiheinen prosessi, joka sisältää sekä hallinnollisia että teknisiä toimenpiteitä. Tutustu yleiskuvaan prosessin vaiheista ja käyttöluvista, joita organisaatiosi täytyy eri vaiheissa hakea.

Hallinnollinen suunnittelu

Aikatauluta ja resursoi käyttöönottoprosessi

  1. Suunnittele, miten organisaatiosi haluaa tulevaisuudessa käyttää Palveluväylää.
  2. Kartoita käyttöönotossa tarvittava osaaminen ja mahdollinen tekninen toteuttaja.
  3. Sovi teknisistä ja hallinnollisista yhteyshenkilöistä.
  4. Suunnittele omille palveluillesi tarvittavat luvat ja sopimukset.

Tekninen suunnittelu

Suunnittele Palveluväylän tekninen käyttöönotto

  1. Perehdy teknisiin lähtökohtiin.
  2. Tutustu Palveluväylän eri ympäristöihin.
  3. Selvitä sopivin liityntäpalvelinratkaisu.

Valitse Palveluväylän liityntäpalvelinratkaisu

Valitse sopivin ratkaisu yhdessä teknisen toteuttajan kanssa

Vaihtoehdot ovat

  • oma liityntäpalvelin
  • yhteinen liityntäpalvelin
  • ulkoistettu liityntäpalvelin.

Jos toteutatte oman liityntäpalvelimen, valmistele alustapalvelin teknisesti

Asenna ja määrittele alustapalvelin.

Hae käyttölupaa Palveluväylän testiympäristöön

Lähetä käyttölupahakemus Palveluväylän testiympäristöön Suomi.fi-palveluhallinnassa.

DVV myöntää käyttöluvan testiympäristöön

DVV myöntää organisaatiollesi käyttöluvan Palveluväylän testiympäristöön ja lähettää asennusohjeet tekniselle yhteyshenkilölle.

Liity Palveluväylän testiympäristöön

Kun käyttölupahakemus on hyväksytty, organisaatiosi voi liittyä testiympäristöön teknisesti. Seuraa saamiasi ohjeita:

  1. Avaa palomuurit
  2. Asenna liityntäpalveluohjelmisto
  3. Määrittele liityntäpalvelin
  4. Lisää alijärjestelmä
  5. Liitä asiakasjärjestelmä liityntäpalvelimelle
  6. Lisää mahdolliset palvelusi liityntäpalvelimelle
  7. Ota sovitinpalvelu tarvittaessa käyttöösi

Kuvaile omat palvelusi Testiliityntäkatalogiin

Kuvaile organisaatiosi ja tarjoamanne palvelut Palveluväylän Testiliityntäkatalogiin.

Testaa teknisesti Palveluväylän testiympäristössä

Kun organisaatiosi on liittynyt onnistuneesti testiympäristöön, testaa yhteys Palveluväylään:

  1. Testaa viestiketjun toimivuus
  2. Testaa viestinvälitystä metapalveluiden avulla
  3. Korjaa testeissä huomatut virheet

Hae käyttölupaa Palveluväylän tuotantoympäristöön

Kun testiympäristössä tehdyt testit on käyty läpi ja virheet korjattu, voitte siirtyä tuotantoympäristöön.

Hae käyttölupaa Palveluväylän tuotantoympäristöön Suomi.fi-palveluhallinnassa.

DVV myöntää käyttöluvan tuotantoympäristöön

DVV myöntää organisaatiollesi käyttöluvan Palveluväylän tuotantoympäristöön ja lähettää asennusohjeet tekniselle yhteyshenkilölle.

Siirry teknisesti Palveluväylän tuotantoympäristöön

Kun käyttölupa tuotantoympäristöön on myönnetty, toista samat tekniset toimenpiteet kuin testiympäristöön liityttäessä.

Kuvaile omat palvelusi Liityntäkatalogiin

Kuvaile organisaatiosi ja tarjoamanne palvelut Palveluväylän Liityntäkatalogiin.

Käyttöönottoprosessi on valmis

Päivitetty: 23.4.2024

Palveluväylän tekniset lähtökohdat

Suomi.fi-palveluväylän tiedonvälitys perustuu X-Road-teknologiaan, jota kehittää Nordic Institute for Interoperability Solutions. Tiedot liikkuvat salattuna julkisessa internetissä. Tietojen välitys perustuu erillisiin fyysisiin tai virtuaalisiin liityntäpalvelimiin.

Tiedot salataan tiedonsiirron ajaksi TLS (SSL) -salausprotokollalla, ja kaikki tieto allekirjoitetaan varmenteilla. Liityntäpalvelinten rajapintatoteutuksessa käytetään XML-kieleen pohjautuvaa SOAP (Simple Object Access Protocol) -tietoliikenneprotokollaa tai REST-arkkitehtuuria.

Päivitetty: 8.2.2024

Palveluväylän ympäristöt

Suomi.fi-palveluväylä toimii kolmessa eri ympäristössä.

Huomioi, että tarvitset kaikkiin ympäristöihin erilliset liityntäpalvelimet, eli fyysiset tai virtuaaliset palvelimet, joiden kautta viestit kulkevat.

Päivitetty: 17.1.2024

Yleistä Palveluväylän liityntäpalvelinratkaisusta

Ennen kuin voit aloittaa käyttöönoton, organisaatiollasi pitää olla erillinen fyysinen tai virtuaalinen palvelin eli liityntäpalvelin, jonka avulla Palveluväylään liitytään. Pohdi suunnitteluvaiheessa, mikä ratkaisu sopii organisaatiollesi parhaiten.

  1. Oman liityntäpalvelimen käyttäminen: Organisaatiosi asentaa liityntäpalvelinohjelmiston sekä huolehtii liityntäpalvelimen ylläpidosta itse.
  2. Liityntäpalvelinratkaisun ostaminen ulkopuoliselta palveluntarjoajalta: Organisaatiosi ulkoistaa liityntäpalvelinohjelmiston asentamisen sekä liityntäpalvelimeen liittyvät ylläpitotyöt jollekin ulkoiselle palveluntarjoajalle.
  3. Jaetun liityntäpalvelimen käyttäminen: Sovitte jonkin Palveluväylään liittyneen organisaation kanssa, että hyödynnätte heidän olemassa olevaa liityntäpalvelintaan. Voitte myös pystyttää toisen organisaation kanssa uuden yhteisen liityntäpalvelimen.
Päivitetty: 22.4.2024

Tekniset rajapinnat: SOAP vai REST

Palveluväylän kautta tarjottavat palvelut voivat perustua joko SOAP-protokollan mukaiseen tiedonsiirtoon tai tiedon esitysmuodosta riippumattomaan REST-arkkitehtuurimalliin.

Jos organisaatiosi aikoo tarjota Palveluväylässä palveluitaan muille, mieti, tuleeko organisaatiosi käyttämään SOAP- vai REST-rajapintoja tietojen välittämiseen. Myös molempien käyttäminen on mahdollista. Rajapinnan muoto vaikuttaa jonkin verran käyttöönottoprosessiin.

Palveluväylään liittymisen kannalta suurin ero SOAP- ja REST-palveluiden välillä on se, että SOAP-palvelut tarvitsevat pääsääntöisesti erillisen sovitinpalvelun, mutta REST-palvelut eivät.

Päivitetty: 19.1.2024

Sovitinpalvelu

Sovitinpalvelu on liityntäpalvelimen ja tietojärjestelmän väliin sijoittuva komponentti, joka sovittaa organisaatiosi järjestelmän palvelut Palveluväylän käyttämän X-Road-tiedonsiirtoprotokollan mukaiseen muotoon. 

Et tarvitse sovitinpalvelua, jos:

  • SOAP-palvelu on suunniteltu ja toteutettu nimenomaan Palveluväylää varten ja Palveluväylän asettamia vaatimuksia noudattaen tai
  • organisaatiosi käyttää REST-rajapintoja tiedonsiirtoon.
Päivitetty: 19.1.2024

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

Muistilista