Ohje
Sovelluspalvelut / Lasse Pynnönen
1 (3)
10.6.2015
Asiointitilin POST-rajapinnan käyttö
Asiointitilin POST-rajapinnan toiminta ja rakenne on kuvattu dokumentissa
”Ohje_Asiointilomakkeen POST-rajapinta yleiskuvaus”.
POST-rajapinnan kutsuminen tapahtuu POST-kutsulla, esimerkiksi html-formilla. Formin
action-parametriksi annetaan käytettävän POST-rajapinnan osoite. Varsinaiset tietokentät
ovat formin sisällä olevia kenttiä, yleensä hidden input –tyyppisiä. Alla esimerkkiformi, jolla
lähetetään yksinkertainen viesti Asiointitilin testiympäristöön.
<form id="postForm" action="https://asiointitilitest.innofactor.com/message/post" method="post">
<input type="hidden" name="ViranomaisTunnus"
id="ViranomaisTunnus" value="Testiviranomainen" />
<input type="hidden" name="PalveluTunnus" id="PalveluTunnus"
value="Testipalvelu" />
<input type="hidden" name="Nimeke" id="Nimeke"
value="Testiviestin otsikko" />
<input type="hidden" name="Kuvausteksti" id="Kuvausteksti"
value="Tämä on testiviestin sisältö" />
</form>
POST-rajapinnan osoitteet eri ympäristöissä
Ympäristö
Osoite
Liittymätesti
https://asiointitili-test.innofactor.com/message/post
Tuotanto
https://asiointitili.suomi.fi/message/post
Valtion tieto- ja viestintätekniikkakeskus Valtori
www.valtori.fi
Ohje
Sovelluspalvelut / Lasse Pynnönen
10.6.2015
POST-lomakkeen kentät
Nimi
Tietotyyppi
Selite
ViranomaisTunnus
merkkijono
POST-lomakkeen vastaanottavan
viranomaisen viranomaistunnus
PalveluTunnus
merkkijono
POST-lomakkeen vastaanottavan
viranomaispalvelun tunnus
Nimeke
merkkijono
Lomakkeen otsikko
Kuvausteksti
merkkijono
Lomakkeen sisältöä kuvaava teksti,
varsinainen lomakesisältö toimitetaan
liitteenä
Paluuosoite
merkkijono
URL-osoite, johon post-rajapinnasta
palataan. Asiointitili lisää
paluuosoitteen URL-parametriksi
tiedon onko käyttäjä lähettänyt viestin
vai keskeyttänyt lähetyksen jossain
vaiheessa lähetystä (Toimitettu=1 tai
0).
PalaaAutomaattisesti
bitti (”0” tai ”1”)
Lippu, jos annettu ”1” niin palataan
automaattisesti lomakkeen
lähetyksen jälkeen paluuosoitteeseen
(jos annettu).
ViranomaisenEmail
merkkijono
Viranomaisen sähköpostiosoite,
johon viesti voidaan ohjata, käytössä
sähköpostiliitynnän tapauksessa
Liitetiedostot
-
Voidaan antaa 0-10 liitetiedostoa,
joissa kussakin ao. 4 kenttää
TiedostoNimi_1
merkkijono
Liitetiedoston 1 nimi
TiedostoSisalto_1
merkkijono
Liitetiedoston 1 sisältö base64enkoodattuna merkkijonona
TiedostoMuoto_1
merkkijono
Liitetiedoston 1 MIME-tyyppi
TiedostoPiilotettu_1
bitti (”0” tai ”1”)
Lippu, jos annettu “1” niin
liitetiedostoa 1 ei näytetä käyttäjälle
asiointitilillä. (esimerkiksi lomakkeen
tiedot XML-muodossa)
…
Vastaavasti liitteet 2...9
TiedostoNimi_10
merkkijono
Liitetiedoston 10 nimi
TiedostoSisalto_10
merkkijono
Liitetiedoston 10 sisältö base64enkoodattuna merkkijonona
Valtion tieto- ja viestintätekniikkakeskus Valtori
www.valtori.fi
2 (3)
Ohje
Sovelluspalvelut / Lasse Pynnönen
10.6.2015
TiedostoMuoto_10
merkkijono
Liitetiedoston 10 MIME-tyyppi
TiedostoPiilotettu_10
bitti
Lippu, jos annettu “1” niin
liitetiedostoa 10 ei näytetä käyttäjälle
Valtion tieto- ja viestintätekniikkakeskus Valtori
www.valtori.fi
3 (3)