VIA Valtion Yhteinen Integraatiopalvelu Palvelukuvaus
Sivu: 2 Sisällysluettelo VVP ipost API... 3 Yleistä... 3 SFTP API... 3 Vaihe 1... 3 VIA... 5 SFTP-palvelin... 5 Vaihe 2... 6 Purkaja... 8 WS API... 8 Versiohistoria... 8
Sivu: 3 VVP ipost API Yleistä Tässä kuvataan viestinvälityspalvelun tarjoamat rajapinnat aineistojen lähetykseen kansalaisille. Aineistojen lähetyksessä on kaksi eri vaihtoehtoa, jotka lyhyesti ovat seuraavat: 1. Lähettää aineisto Opus Capitan määrittämässä muodossa SFTP -siirtona 2. Lähettää pieniä yksittäisiä aineistoja WS-rajapinnan kautta SFTP API SFTP API kautta aan lähettää aineistoja tulostukseen. Ensimmäisessä vaiheessa kaikki aineistossa olevat kirjeet lähetetään käyttäjille paperipostina. Vaihe 1 Aineiston kuvaus noudattaa skeemaa: LetterBundle_V1x0.xsd, joka on Opus Capitan tekemä. Myös liitetyn pdf-tiedoston tulee noudattaa määritettyä rakennetta, jotta aineiston käsittely on mahdollista. Toimitettavat aineistot ovat zip-pakattuja bundleja, jotka sisältävät yhden pdf + xml tiedostoparin. Aineiston kuvaus löytyy osoitteesta: http://www.ipost.fi/nain-se-toimii/faktat/suunnitteluohje/ipost-peruspalvelu-ja-ipost-pdf/ Aineistot siirretään SFTP-siirtona VIA tarjoamalle levypinnalle. VIA hoitaa aineistojen virustarkistuksen ja sen jälkeen siirron automaattisesti eteenpäin Opus Capitan tulostuspalveluun. Jos on esim. aiemmin käyttänyt Opus Capitan ipost palvelua, tämä rajapinta on täysin yhteensopiva sen kanssa. Tiedoston lähettäjä on vastuussa siirron onnistumisesta ja mm. siitä ettei samaa tiedostoa siirretä kahteen kertaan. Aineistossa saa olla maksimissaan 10 000 riviä ja suurin lähetettävä tiedosto (per käyttäjä) on maksimissaan 300 KB. Lähettäjällä tulee olla voimassaoleva sopimus Opus Capitan kanssa ja aineiston tulee sisältää asiakastunnus (customerid) ja salasana (passwd) jotta aineisto aan lähettää eteenpäin.
Sivu: 4 Vaihe 1 SFTP - (Interaction diagram) SFTP-palvelin :VIA_OC Palvelu :Tallennuspalvelu :Opus Capita / Itella :Viranomaistoimija :Loppukäyttäjä / käyttäjä / kansalainen Vie aineisto (zip-tdsto) Lue hakemisto(): filename Väitä tieto(file_ref) Virustarkistus() :file id Noutopyyntö(file id) Nouda(file_id): zip-tdsto Käsittele() Toimita(kirjeposti) Kuva: 1 Vie aineisto Viranomainen toimittaa tiedoston tulostukseen VIA määrittämään paikaan (SFTP put). Lue hakemisto filename VIA lukee SFTP input-hakemistoa Väitä tieto Välitetään tiedoston lokaatio tallennuspalvleulle Virustarkistus Tarkistetaan tiedosto viruksista ja asetetaan tiedosto Opus Capitalle näkyväksi. file id Palautetaan id tallennuspalvelussa. Noutopyyntö Pyydetän Opus Capitaa noutamaan tiedosto. Nouda zip-tdsto OC noutaa aineiston tulostukseen Käsittele OC sisäinen käsittely
Sivu: 5 Toimita OC toimittaa asiakkaalle kirjeen paperipostin kautta. VIA Valtorin VIA (integratioalusta) SFTP-palvelin Valtorin SFTP-palvelin jonne aineistot siirretään
Sivu: 6 Vaihe 2 Toiminta on identtinen kuin vaiheessa 1, mutta aineisto käsitellään palvelussa. Aineisto käydään läpi jokaisen lähetettävän henkilön osalta ja jos henkilöllä on käytössä tili viestinvälityspalvelussa, lähetetään aineistossa oleva kirje hänelle sähköisesti, jonka kansalainen voi käydä lukemassa kansalaisen palvelunäkymissä. Tilin olemassaolo tarkistetaan ohjaustiedoissa (xml- tdsto) olevista henkilötunnuksista (Recipient.SSN). Ne henkilöt joilla ei ole käytössä sähköistä palvelua, kirje lähetetään normaalisti paperikirjeenä entiseen tapaan. Aineiston maksimikoko on 2 GB ja suurin lähetettävä tiedosto (per käyttäjä) on maksimissaan 300 KB (OC asettama rajoitus paperitulosteille). Vaihe 2 - (Interaction diagram) SFTP-palvelin :VIA_OC Palvelu :Tallennuspalvelu Purkaja :Viestintäratkaisu :Opus Capita / Itella :Palvelunäkymät :Viranomaisjärjestelmä :Loppukäyttäjä / käyttäjä / kansalainen Vie Aineisto(zip-tdsto) Lue hakemisto(): filename Välitä tieto(file_ref) :file_id Virustarkastus() Noutopyyntö(file_id) Nouda(file_id) Käsittele aineisto() *Lähetä viesti() *Tallenna(): file_id *:file_id *Noutopyyntö(file_id) Käsittele() Toimita(kirje) Hae viesti() Hae viesti() Kuva: 2 Vie Aineisto Viranomainen toimittaa tiedoston tulostukseen. Lue hakemisto filename Haetaan tiedosto käsittelyyn Välitä tieto Välitetään tiedoston lokaatio tallennuspalvleulle Virustarkastus
Sivu: 7 kautta. Tarkistetaan aineisto viruksista. file_id Palautetaan tiedoston tunniste Noutopyyntö Pyydetään noutaman aineisto. Nouda Noudetaan tdsto Käsittele aineisto Suoritetaan aineistolle pilkonta ja läpikäynti (sähköinen toimitus/paperinen) Lähetä viesti Lähetetään viesti viestinvälityspalveluun, josta kansalainen voi sen käydä lukemassa palvelunäkymien Tallenna file_id Tallennetaan pilkotut ja muokatut tiedostot. file_id Palautetaan tunniste Noutopyyntö Pyydetään OC noutamaan aineistot. Käsittele OC sisäinen käsittely Toimita Toimitetetaan paperikirjeenä Hae viesti Kansalainen halua lukea viestin sähköisesti. Hae viesti Haetaan viesti VVP_palvelusta
Sivu: 8 Purkaja Purkaja pilkkoo isot tiedostot (yli 10 000 riviä/yli 200 MB) paloihin. Sen jälkeen purkaja käy aineistot läpi siten että jos hetulla (SSN) löytyy aktiivinen tili, aineisto lähetetään sähköisesti VVP-palveluun. Samalla kyseinen henkilö poistetaan paperitulostuksesta. Kirjeet niille henkilöille joille tiliä ei löytynyt, ohjataan Opus Capitalle tulostuspalveluun. Huom. Alkuperäinen tiedosto on voinut pilkkoutua useampaan osaan. WS API Ks. dokumentti VVP ViranomaisAPI.docx. Versiohistoria Versio 0.1 / Tero Rönkä / 16.9.2016