Rajapinnan käytön tekniset edellytykset suomi.fi -palveluväylä

Rajapinta-asioiminen Kansallisarkiston kanssa, kuten esimerkiksi arkistoitavien tietoaineistojen ja näitä kuvailevien kontekstimetatietojen siirtäminen, tapahtuu Suomi.fi-palveluväylän kautta. Asioiva organisaatio voi liittyä palveluväylään asentamalla oman liityntäpalvelimen tai käyttämällä yhteistä liityntäpalvelinta, jonka on asentanut toinen taho tai IT-toimittaja.

Valmistelu

• Tutustu huolellisesti Palveluväylän aineistoon
  https://palveluhallinta.suomi.fi/fi/sivut/palveluvayla/esittely ja palvelun kuvaukseen
  https://palveluhallinta.suomi.fi/fi/sivut/palveluvayla/palvelukuvaus/palvelun-kuvaus .

• Suunnittele ja varaa liittymiseen tarvittavat resurssit (aika, henkilöstö) ja budjetti (hankinnat, sopimukset).

• Määrittele tarvittavat roolit organisaation sisällä (tai mahdollisen IT-toimittajan kanssa):

  • Hallinnollinen yhteyshenkilö

  • Hallinnollinen varayhteyshenkilö

  • Tekninen yhteyshenkilö

  • Tekninen varayhteyshenkilö

• Kannattaa määritellä Palveluväylän mahdolliset käyttötarpeet myös muunkin käytön osalta, ei vain ensisijaisen käyttötarpeen sisällä.

Liittymisluvan hakeminen

• Liittymisluvan hakeminen aloitetaan testiympäristöön (FI-TEST) liittymisestä.

  •  Kehitysympäristöä (FI-DEV) ei tarvita (rajapinnan kehitykseen), eikä tuotantoympäristöön (FI) voi liittyä ennen käytön testaamista.

• Täytä käyttölupahakemus sivulla
  https://palveluhallinta.suomi.fi/fi/sivut/palveluvayla/kayttoonotto/vaiheet > Tee käyttölupahakemus

  • Lue tarkkaan käyttöönoton prosessi. Sieltä löytyvät selitykset ja linkit mm. esimerkkihakemukseen, tarvittavien tietojen kuvauksiin ja varmennehakemusten sisältöihin.

  • Lue myös palveluväylän käyttöehdot
    https://palveluhallinta.suomi.fi/storage/cms.files/mCIkgj4nD954f3u5.pdf. Ne täytyy hyväksyä ennen hakemuksen lähettämistä.

Liityntäpalvelimen asennus

Palomuuriavaukset

• Palveluväylän ylläpito lähettää ohjeet liityntäpalvelimen porttien avaamisesta. Ylläpito palauttaa liittyjälle myös seuraavat tiedot, joita tarvitaan palvelimen liittämiseen testiympäristöön:

  • Konfiguraatioankkuri (xml-tiedosto).

  • Nimi, jolla liittyvä organisaatio on rekisteröity palveluväylään (Member Name).

Ohjelmiston asennus

• Palveluväylän RHEL- tai Ubuntu-liityntäpalvelin:

  • https://palveluhallinta.suomi.fi/fi/tuki/artikkelit/60a7d7f457a5ec0598c14e7a

• Palveluväylän kontitettu liityntäpalvelin:

  • https://palveluhallinta.suomi.fi/fi/tuki/artikkelit/6034cfd7d23eec08851c0e8a

Varmenteiden hakeminen ja asentaminen

• Liityntäpalvelimen liittäminen testi- tai tuotantoympäristöön:

  • https://palveluhallinta.suomi.fi/fi/tuki/artikkelit/59145e7b14bbb10001966f72

  • 1. Lähetä käyttöliittymässä luomasi allekirjoitus- ja autentikointivarmenteiden hakemukset (CSR-tiedostot) osoitteeseen: palveluvayla@palveluvayla.fi

  • 2. Asenna paluupostissa saamasi DVV:n allekirjoittamat varmenteet käyttöliittymässä

• HUOM. Jos olet liittämässä organisaatioitasi palveluväylään olemassa olevan liityntäpalvelimen kautta, autentikointivarmenteen hakemusta ei tarvitse tehdä; riittää että haet vain allekirjoitusvarmennetta.

Käyttöönotto

• Liityntäpalvelin on seuraavaksi konfiguroitava lisäämällä siihen (vähintään yksi) alijärjestelmä, jotta palvelimella voi käyttää palveluväylään liitettyjen muiden toimijoiden palveluja.

  • Alijärjestelmä on asiakasjärjestelmän yksilöivä tunnus palveluväylässä ja sitä käytetään palveluiden kutsumisessa.

  • Alijärjestelmän luomisen (ja poistamisen) ohjeet löytyvät sivulta
    https://palveluhallinta.suomi.fi/fi/tuki/artikkelit/591ac1e314bbb10001966f9c

  • Muiden toimijoiden tarjoamat palvelut ovat asiakasjärjestelmiä ja ne on liitettävä liityntäpalvelimen alijärjestelmään. Ohjeet asiakasjärjestelmän liittämiseen: https://palveluhallinta.suomi.fi/fi/tuki/artikkelit/592fbd1603f6d100018db5f8

• Tarvittaessa liityntäpalvelimen kanssa on käytettävä sovitinpalvelua, joka muuttaa lähetettävän tiedon palveluväylän rajapintojen ymmärtämään muotoon. Katso ohjeet sivulta
  https://palveluhallinta.suomi.fi/fi/tuki/artikkelit/591ec60614bbb10001966fd0

Testaaminen

Liityntäpalvelimen toimimista yleisesti voit kokeilla kutsumalla mitä tahansa Palveluväylään liitettyä julkista alijärjestelmää, esim. https://liityntakatalogi.test.suomi.fi/dataset/testservice

Tuotantoympäristöön siirtyminen

• Huom! samaa liityntäpalvelinta ei voi käyttää sekä testauksessa että tuotannossa.

• Tuotantoympäristöön liittyminen tapahtuu samalla tavalla kuin testiympäristöönkin.

• Aloita asentamalla uusi liityntäpalvelin.

  • Kun lisäät tuotantoympäristön liityntäpalvelimeen DVV:ltä saamasi varmenteet, varmista että ne ovat juuri tuotantoympäristöön, ei aiempaan testiympäristöön saadut.