VTJkysely-rajapinnan tekninen toteutus

Tälle sivulle on koottu teknistä tietoa VTJkysely-rajapinnasta. Yleisempää tietoa löydät VTJkysely-rajapinnan sivulta.

VTJkysely-rajapinta on XML (SOAP)-protokollan mukaisia sanomia vastaanottava ja palauttava sovelluspalvelu (web service). Asiakasorganisaation tietojärjestelmä lähettää VTJkysely-rajapinnan kautta kyselyn palveluun, josta palautuu vastaussanomana kyselyä vastaavat VTJ-tiedot.

Tietojen siirto VTJkysely-rajapinnan ja asiakasjärjestelmän välillä tapahtuu Internetin kautta HTTPS/TLS-suojattuna. Tietoliikenteen suojauksessa tulee käyttää TLS 1.2 tai uudempaa suojausprotokollaa.

Yhteyden muodostamisessa edellytetään Digi- ja väestötietoviraston tarjoaman Suomi.fi-palveluväylän käyttöä. Palveluväylän käyttöönoton yksityiskohdista löydät lisää tietoa Suomi.fi-sivustolta.

Organisaationne käyttöön myönnettävän tuotteen (vastaussanoman) sisältämät VTJ-tiedot sovitaan tietoluvan hakuprosessin yhteydessä. Kukin asiakasorganisaatio saa vastaussanomassa vain niitä tietoja haun kohteesta (kuten henkilö, huoneisto, rakennus tai kiinteistö), joihin sillä on oikeus.

Digi- ja väestötietovirastolla on valmiita tuotteita erilaisilla tietosisällöillä eri käyttötarkoituksiin. Mikäli organisaationne ei löydä tietotarpeisiinne sopivaa tuotetta, voidaan teille räätälöidä uusi tuote. Luettelon rajapinnan kautta tällä hetkellä saatavissa olevista henkilötiedoista ja niiden muodosta löydät tältä sivulta löytyvästä henkilötietokatalogista (XML Schema -muodossa).

Yleiskuvauksen rajapinnan teknisestä toiminnasta, kuten erilaisista haku- ja vastaussanomatyypeistä, löydät tältä sivulta ladattavissa olevasta sovellusrajapinnan tekninen kuvaus -dokumentista (WSDL-muodossa).

Pääsääntöisesti tietoja luovutetaan vain haun kohteen yksilöivällä tunnuksella, kuten henkilötunnuksella, sähköisellä asiointitunnuksella tai rakennustunnuksella. Tietoja voidaan hakea myös muilla kuin yksilöivillä hakukriteereillä, mikäli asiakasorganisaation tehtävät edellyttävät sitä lain mukaan.

Organisaation tulee hoitaa lokitus asianmukaisesti. Sovelluskyselyyn oikeuden saanut organisaatio on velvollinen säilyttämään lokitiedot viideltä (5) vuodelta. Organisaation on pystyttävä jälkikäteen kertomaan, kuka kyselyn on tehnyt (henkilötasolla), mitä tietoja on haettu ja milloin kysely on tehty (pp.kk.vvvv klo).

Luvan saaja vastaa myös asiakasjärjestelmän tietoturvallisuudesta ja jokaisen haetun tiedon käsittelyn lainmukaisuudesta ja että kyselyt ovat tietoluvan ehtojen ja myönnettyjen tuotteiden käyttötarkoituksen mukaisia.

Huomaa, että oman tietojärjestelmän koko asiakas- tai muun rekisterin tietojen ajantasaisuuden tarkistus VTJkysely-rajapinnasta ei ole sallittua. Jos tarpeenne on tämänkaltainen, soveltuvampi palvelu löytyy todennäköisesti asiakasrekisterien päivityspalveluista julkiselle sektorille tai yksityiselle sektorille.

VTJkysely-rajapinnan palvelukuvaus -dokumentista löydät tarkemman kuvauksen palvelusta ja asiakasorganisaation velvoitteista.

Toimi näin

Lue lisää VTJkysely-rajapinnan käyttöönotosta VTJkysely-rajapinnan sivuilla.

VTJkysely-rajapinnan käyttöönotto Palveluväylän kautta

Liity Suomi.fi-palveluhallintaan.
Liity Suomi.fi-palveluväylään.
Hae testiväylän käyttölupaa.
Valitse sopiva liityntäpalvelinratkaisu.
Määrittele liityntäpalvelimelle vähintään yksi alijärjestelmä.
Testaa väylän testiympäristössä Palveluväylän testipalveluilla.
Pyydä VTJkysely-rajapinnan käyttölupa Palveluväylän testiympäristöön. Integroi ja testaa VTJkysely-rajapinnan ohjeiden mukaan.
Hae Palveluväylän tuotannon käyttölupaa ja siirry tuotantoympäristöön.

VTJkysely-rajapinnan käyttölupaa kannattaa hakea rinnakkain Palveluväylän käyttöluvan kanssa.