VTJkysely-palvelu Sovelluskyselyiden rajapintakuvaus 3.9.2014
2 (6) 3.9.2014 VERSION HALLINTA versionro mitä tehty pvm/henkilö 1.4 päivitetty yhteystiedot 3.9.2014/Kaija Riihijärvi 1.3 päivitetty yhteystiedot 6.2.2013/Kaija Riihijärvi 1.2 päivitetty 17.2.2011/Kaija Riihijärvi ja Teija Aalto 1.1 päivitetty yhteyshenkilöiden tiedot 22.6.2009/Kaija Riihijärvi 1.0 asiakasversio 1.10.2007/Joonas Kankaanrinne ja Arto Ikonen
3 (6) 3.9.2014 Sisältö 1 VTJkyselyn sovelluskyselyiden rajapinta... 4 1.1 VTJkyselyn sovelluskyselyt... 4 1.1.1 WebService rajapinnan periaatteet... 4 1.1.2 Asiakkaan client -toteutus... 5 1.2 Asiakkaalle toimitettava materiaali... 5 1.3 Asiakkaalta vaadittavat tiedot... 6 1.4 Testaus... 6 1.5 Yhteystiedot... 6
4 (6) 1 VTJkyselyn sovelluskyselyiden rajapinta Tässä dokumentissa kuvataan tekniseen toteutukseen liittyviä asioita. 1.1 VTJkyselyn sovelluskyselyt VTJkyselyn sovelluskyselyt tarjotaan asiakkaille WebService -rajapinnoilla suojattujen internetyhteyksien välityksellä. Soap kyselyn muodostus Client -varmen-teen liittäminen XML vastaus- 1.1.1 WebService rajapinnan periaatteet kaikki tunnuskyselyiden kyselytiedot välitetään SOAP -kutsun parametreina tunnistus- ja poimintakyselyissä kyselyparametrit välitetään SOAP bodyyn liitettävässä kyselysanomassa yhteentoimivuuden varmistamiseksi WebService -palvelun sanomissa ei käytetä SOAP - laajennuksia Väestörekisterikeskus PL 123 00531 Helsinki
5 (6) 1.1.2 Asiakkaan client -toteutus Asiakas tarvitsee sovelluskyselyä varten WebService clientin, joka pystyy kommunikoimaan http(s) protokollalla VTJ:n WebService rajapintaan (portti 443) WebService -client voidaan ohjelmoida tai generoida automaattisesti VTJ:n WebService rajapinnasta saatavan WSDL -kuvauksen perusteella Asiakkaan yhteys tunnistetaan SSL kättelyyn välitettävällä palvelinvarmenteella (jossa laajennettu avaimen käyttö on Client autentication/asiakkaan käyttöoikeuksien tarkistus). Palvelinvarmenteen on oltava luotettavan myöntäjän myöntämä ja sillä on oltava julkisesti saatavilla oleva sulkulistapalvelu. Asiakas välittää SOAP kutsun parametreina käyttäjätunnuksen ja salasanan käyttöoikeustarkastusta varten. VRK ilmoittaa tarvittaessa voimassaolevaan käyttäjätunnukseen uuden salasanan. On suositeltavaa, että VRK:n myöntämät käyttäjätunnus ja salasana tiedot ovat helposti vaihdettavissa asiakasyhteyden konfiguraatioon. Kyselyn yhteydessä on aina välitettävä myös loppukäyttäjän tunnus. Loppukäyttäjän tunnuksen perusteella asiakkaan on pystyttävä tarvittaessa selvittämään VRK:lle kyselyn tekijä viisi vuotta kyselyhetkestä taaksepäin. 1.2 Asiakkaalle toimitettava materiaali sovelluskyselyjen rajapintakuvausdokumentti (tämä dokumentti) palvelun WSDL -kuvaus sovellustyötä varten tunnistus- ja poimintakyselyiden kyselysanoman XML-kuvaus ja tarvittaessa myös esimerkkisanoma vastaussanomakuvaus ja esimerkki tarvittaessa vastaussanomakuvaukseen liittyvä henkilö-, rakennus- tai kiinteistötietojen tietokatalogi, johon tuotekohtaisessa kuvauksessa viitataan. Katalogissa kuvataan käytettävät tietotyypit käyttäjätunnus ja salasana VRK:n palvelinvarmenne asiakkaan palvelimelle asennettavaksi testitapausluettelo Väestörekisterikeskus PL 123 00531 Helsinki
6 (6) 1.3 Asiakkaalta vaadittavat tiedot palvelinvarmenne (client-autentication ominaisuudella) 1.4 Testaus VRK testaa kaikki sovelluskyselyt ennen asiakastestiä Asiakas testaa toteutuksensa VTJ:n koulutusympäristöä vasten ennen tuotantoon siirtoa VRK:lta saadun testitapausluettelon perusteella 1.5 Yhteystiedot Sovelluskyselyt ja tekniset asiat : Teija Aalto puh. 0295 535 202, gsm 050 306 2269 teija.aalto@vrk.fi Kaija Riihijärvi puh. 0295 535 291 gsm 050 306 2388 kaija.riihijarvi@vrk.fi Testaus Tuija Väre puh. 0295 535 322 gsm 050 431 4528 tuija.vare@vrk.fi Asiakaskohtainen tietosisältö ja sopimusasiat VRK:n asiakastuki vaihde 0295 535 001 julkishallinto@vrk.fi yritysasiakkaat@vrk.fi puh. 0203 43 433 vrk.sd@tieto.com Väestörekisterikeskus PL 123 00531 Helsinki