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.

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

Rekisteröidy Suomi.fi-palveluhallintaan

Suomi.fi-palveluväylän käyttöönotto edellyttää, että olet rekisteröitynyt Suomi.fi-palveluhallinnanAvautuu uuteen ikkunaan. käyttäjäksi ja kuulut Palveluhallintaan rekisteröityyn organisaatioon.

  • Jos organisaatiosi ei ole aikaisemmin käyttänyt Palveluhallintaa, sinun pitää perustaa uusi organisaatiotili. Tarvitset tähän organisaatiosi nimenkirjoitusoikeuden.
  • Jos organisaatiosi on jo rekisteröity Palveluhallintaan, tarvitset kutsun organisaatiosi toiselta käyttäjältä liittyäksesi organisaatiosi käyttäjäksi.

Tutustu tarkempiin ohjeisiin Suomi.fi-palveluhallintaan rekisteröitymisestä.Avautuu uuteen ikkunaan.

Päivitetty: 23.1.2024

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

Organisaatiosi on testattava ensin Palveluväylän käyttöä testiympäristössä. Tarvitset testiympäristöön käyttöluvan. Hae testiympäristön käyttölupaa Suomi.fi-palveluhallinnassa.Avautuu uuteen ikkunaan.

Jos tekninen toimittaja on rekisteröitynyt Suomi.fi-palveluhallinnassa välitoimijaksi, se voi myös täyttää käyttölupahakemuksen organisaatiosi puolesta. Hakemuksen allekirjoittaa kuitenkin aina hallinnollinen yhteyshenkilö. 

Kun käyttölupahakemuksesi on hyväksytty, tekninen yhteyshenkilö saa sähköpostitse asennusohjeet tuotantoympäristöön liittymistä varten.

Löydät lisää ohjeita käyttölupahakemuksen täyttämiseen erillisestä tukiartikkelista.Avautuu uuteen ikkunaan.

Päivitetty: 22.4.2024

Tutustu asennusohjeisiin

Projektin hallinnollinen vastuuhenkilö lähettää käyttölupahakemuksen Palveluväylän testiympäristöön.

Kun käyttölupahakemus on hyväksytty, tekninen yhteyshenkilö saa sähköpostitse asennusohjeet testiympäristöön liittymistä varten. Ohjeet tulevat osoitteesta palveluvayla@palveluvayla.fi. Saat sähköpostitse seuraavat materiaalit:

  • konfiguraatioankkuri
  • palomuurien avausohjeet
  • ohjeet varmennepyyntöjen luomiseen ja lähettämiseen
  • ohjeet liityntäpalvelinohjelmiston asentamiseen.
Päivitetty: 22.4.2024

Avaa palomuurit

Avaa tarvittavat portit palvelimeltasi saamiesi ohjeiden mukaan, jotta yhteydet Palveluväylään toimivat. Tietoturvan kannalta on erittäin tärkeää, että vain tietyt portit ovat auki oikeisiin suuntiin.

Tietoturvasyistä Palveluväylän ylläpito lähettää ohjeet porttien avaamiseen sähköpostitse tekniselle yhteyshenkilölle. Tarvittaessa voit saada ohjeet palomuuriavauksiin jo ennen käyttölupahakemuksen lähettämistä. Ota tällöin yhteyttä Palveluväylän ylläpitoon osoitteessa palveluvayla@palveluvayla.fi.

Katso ohjevideo muurienavausvaiheesta (Youtube).Avautuu uuteen ikkunaan.

Päivitetty: 22.3.2024

Asenna liityntäpalvelinohjelmisto

Asenna liityntäpalvelinohjelmisto alustapalvelimellesi. Alustapalvelimesta tulee tämän jälkeen liityntäpalvelin, jonka liität Palveluväylän testiympäristöön. Asennusvaiheet riippuvat osittain käytetystä käyttöjärjestelmästä. Katso ohjeet Palveluhallinnasta:

Katso ohjevideo liityntäpalvelinohjelmiston asentamisesta (Youtube).Avautuu uuteen ikkunaan.

Päivitetty: 23.1.2024

Määrittele testiympäristön liityntäpalvelin

Asennuksen jälkeen sinulla on liityntäpalvelin, joka on valmis konfiguroitavaksi. Voit määritellä liityntäpalvelimen ohjelmallisesti automaattisilla hallintaskripteillä (X-Road Toolkit) tai manuaalisesti graafisen käyttöliittymän tai hallintarajapinnan kautta.

Palveluväylän ylläpito hyväksyy rekisteröinnin yleensä noin vuorokaudessa. Voit seurata rekisteröinnin tilaa liityntäpalvelimen hallintakäyttöliittymästä. Saat myös sähköpostin, kun rekisteröinti on valmis.

Päivitetty: 17.1.2024

Lisää testiliityntäpalvelimelle alijärjestelmä

Lisää liityntäpalvelimelle ainakin yksi alijärjestelmä, joka mahdollistaa tiedonsiirron Palveluväylässä. Alijärjestelmä toimii rajapintana Palveluväylään tiedon hakemista ja jakamista varten.

Suosittelemme käyttämään lähtökohtaisesti asiakasjärjestelmäkohtaisia alijärjestelmiä. Asiakasjärjestelmällä tarkoitetaan organisaatiosi tietojärjestelmää, johon liityntäpalvelin yhdistetään, jotta tietojärjestelmän sisältämiä tietoja voidaan jakaa Palveluväylään tai ladata Palveluväylästä tietojärjestelmään. 

Joissakin tapauksissa myös useat, yhden loogisen kokonaisuuden muodostavat asiakasjärjestelmät voivat hyödyntää samaa alijärjestelmää palvelujen kutsumiseen.

Jos tarjoat palveluita Palveluväylässä, suosittelemme, että sinulla on yksi alijärjestelmä jokaista tarjoamaasi palvelua kohden.

Päivitetty: 22.3.2024

Liitä asiakasjärjestelmäsi liityntäpalvelimelle

Kun liityntäpalvelin ja alijärjestelmät ovat kunnossa, liitä asiakasjärjestelmäsi liityntäpalvelimelle. Asiakasjärjestelmän liittäminen liityntäpalvelimeen tapahtuu liityntäpalvelimelle luomasi alijärjestelmän kautta. Tee liittäminen liityntäpalvelimen hallintakäyttöliittymässä. Seuraa Asiakasjärjestelmän liittäminen liityntäpalvelimeen -tukiartikkelinAvautuu uuteen ikkunaan. ohjeistusta.

Katso ohjevideo asiakasjärjestelmän liittämisestä ja alijärjestelmän toiminnan testaamisesta (Youtube).Avautuu uuteen ikkunaan.

Päivitetty: 23.1.2024

Hae testialijärjestelmälle käyttölupa VTJ-muutosrajapintaan

Kun organisaatiosi on lisännyt alijärjestelmänsä testiliityntäpalvelimelle, voitte testata VTJ-muutosrajapinnan testihiekkalaatikon toimintaa Palveluväylän kautta. Tarvitsette sitä varten testialijärjestelmälle käyttöluvan VTJ-muutosrajapintaan.

Hakemuksen tekee hallinnollinen yhteyshenkilö. Kysy tarvittaessa apua tekniseltä yhteyshenkilöltä.

Täytä käyttölupahakemus (PDF)Avautuu uuteen ikkunaan. ja lähetä se osoitteeseen muutostietopalvelu@dvv.fi.

Päivitetty: 22.3.2024

Jos aiot tarjota palveluita muille, lisää palvelusi testiympäristön liityntäpalvelimelle

Jos haluat tarjota palveluita muille, sinun täytyy lisätä palvelusi liityntäpalvelimelle. Kun olet lisännyt liityntäpalvelimellesi alijärjestelmän ja se on rekisteröity, lisää sen alle uusi palvelu liityntäpalvelimen hallintakäyttöliittymän kautta. Seuraa Palvelun lisääminen liityntäpalvelimelle -tukiartikkelinAvautuu uuteen ikkunaan. ohjeistusta.

Voit lisätä kahdenlaisia palveluja:

  • SOAP-palvelu. Palvelu lisätään antamalla WSDL-kuvauksen polku.
  • REST-palvelu. Palvelu lisätään antamalla: OpenAPI 3 Description -polku tai REST API Base Path -polku.

Päivitetty: 12.4.2024

Ota tarvittaessa sovitinpalvelu käyttöön

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.

Tarvitset sovitinpalvelun, jos

  • tarjoat Palveluväylän kautta SOAP-palveluita, joita ei ole luotu erikseen Palveluväylää varten Palveluväylän asettamia vaatimuksia noudattaen
  • organisaatiosi ei käytä REST-rajapintoja tiedonsiirtoon.

Lue lisää eri toteutusvaihtoehdoista Palveluväylän sovitinpalvelu -tukiartikkelista.Avautuu uuteen ikkunaan.

Päivitetty: 23.1.2024

Jos aiot tarjota palveluita muille, kuvaile organisaatiosi ja palvelusi Testiliityntäkatalogiin

Kun Palveluväylän testiympäristön tekninen liittymisprosessi on valmis ja palvelusi löytyvät testiympäristöstä, saat tunnukset TestiliityntäkatalogiinAvautuu uuteen ikkunaan.. Kuvaile organisaatiosi sekä palveluidesi tiedot Testiliityntäkatalogiin vähintään suomeksi ja ruotsiksi. 

Varmista, että alijärjestelmäsi näkyy oikein Testiliityntäkatalogissa ja tutustu tarjolla oleviin palveluihin. Lue lisää Liityntäkatalogin ympäristöistä.Avautuu uuteen ikkunaan.

Kun kuvaat palvelusi huolellisesti, on muiden helpompi löytää palvelusi ja hyödyntää niitä. Älä kirjoita kuvausta liian teknisellä kielellä, vaan pyri yleistajuiseen ilmaisuun. Kirjoita kuvaus ytimekkäästi, mutta muista kertoa kaikki oleellinen. Kun kirjoitat kuvaukset hyvin, voit kopioida ne myöhemmin tuotantoympäristöön.

Päivitetty: 23.1.2024

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

Muistilista