Suomi.fi kehittäjille
Siirry suoraan sisältöön.

Yleiset käsittelysäännöt

Beta - sisältö on kesken


Tämä sivu on alustava ja täydentyy kevään 2026 aikana rajapintaversion 12 kehitystyön edetessä.

Sisällön julkaisemisen säännöt

Sisällön julkaiseminen

  • Rajapintaversion 12 kautta voidaan tuoda ja päivittää ainoastaan julkaistu -tilaista sisältöä.
  • Palvelun tai asiointikanavan kieliversion voi julkaista vain silloin, kun palvelun päävastuuorganisaatio tai asiointikanavan organisaatio on julkaistu kyseisellä kieliversiolla.

Sisällön hakeminen

  • Rajapinnan kautta voidaan hakea vain julkaistua sisältöä.
  • Poikkeus: Arkistoitua sisältöä (esim. palvelut ja asiointikanavat) voidaan hakea, jotta integraattori voi poistaa omasta järjestelmästään arkistoidun sisällön.

Sisällön näkyvyys suomi.fi-verkkopalvelussa

  • Suomi.fi:ssä näkyvät ne organisaatiot, palvelut ja asiointikanavat, jotka on julkaistu. Mikäli organisaatiolla ei ole julkaistuja palveluita tai asiointikanavia, sen tietoja ei näytetä.


Tietojen yleiset säännöt

Sisällön tilan säännöt

  • Sallitut tilasiirtymät ovat (täydentyy myöhemmin)

Kieliversiot

  • Tietosisältöjen mahdolliset kieliversiot ovat suomi, ruotsi, englanti, pohjoissaame, inarinsaame ja koltansaame

Muotoiltu tekstikenttä

  • Kenttään (esim. Palvelun kuvaus) voidaan syöttää tekstiä, jossa käytetään muotoiluja (esim. otsikot, listat, korostukset). Rajoitukset: kuvien ja hyperlinkkien lisääminen ei ole mahdollista. Rajapinta vastaanottaa ja palauttaa muotoilut Markdown -syntaksin mukaisesti.

Aluetiedot

  • Valitse yksi seuraavista: Koko maa, Koko maa paitsi Ahvenanmaa, Rajattu alue
  • Jos aluetiedoksi on valittu Rajattu alue, ks. kohta Aluetiedot -rajattu alue

Aluetiedot -rajattu alue

  • Valitse vähintään yksi vaihtoehto (kunta, maakunta tai hyvinvointialue)
  • Kunta: voidaan valita yksi tai useampi kunta
  • Maakunta: voidaan valita yksi tai useampi maakunta
  • Hyvinvointialue: voidaan valita yksi tai useampi hyvinvointialue
  • Voit valita useita vaihtoehtoja kaikkiin seuraaviin kohtiin: Kunta, Maakunta, Hyvinvointialue. On siis mahdollista valita esim. kolme kuntaa, yksi maakunta ja yksi hyvinvointialue.

Palveluaika

  • (Kuvaus täydentyy myöhemmin)

Puhelinasiointikanavan puhelinnumero

  • Suuntanumero on pakollinen
  • Puhelinnumero on pakollinen
  • Lisätieto on valinnainen
  • Puhelun hintatieto on pakollinen. Valitse yksi seuraavista: Maksullinen, Maksuton, Lisämaksullinen
  • Hintatiedon kuvaus on pakollinen, jos hintatiedoksi on valittu Lisämaksullinen

Verkko-osoite

  • Nimi on pakollinen
  • Verkko-osoite on pakollinen
  • Verkko-osoitteen alussa tulee olla merkkijono: http:// tai https://
  • Kuvaus on valinnainen

Sijaintitiedot

Voi olla katuosoite, muu sijaintieto tai ulkomainen osoite

Yhteystiedot

Voi olla sähköpostiosoite, faksinumero, puhelinnumero, verkkosivuosoite tai postiosoite.

Postiosoite voi olla katuosoite, postilokero-osoite tai ulkomainen osoite.

Sähköpostiosoite

  • Sähköpostiosoite on pakollinen
  • Lisätieto on valinnainen

Käytön tuki - sähköpostiosoite

  • Sähköpostiosoite on pakollinen

Faksinumero

  • Maakohtainen suuntanumero on pakollinen
  • Puhelinnumero on pakollinen

Puhelinnumero

  • Onko suomalainen (valtakunnallinen) palvelunumero, johon ei voi soittaa ulkomailta, Kyllä/Ei
  • Suuntanumero on pakollinen, jos "Onko kyseessä suomalainen (valtakunnallinen) palvelunumero" on Ei
  • Puhelinnumero on pakollinen
  • Lisätieto on valinnainen
  • Puhelun hintatieto on pakollinen. Valitse yksi seuraavista: Maksullinen, Maksuton, Muu
  • Hintatiedon kuvaus on pakollinen, jos hintatiedoksi on valittu Muu

Katuosoite

  • Kadunnimi on pakollinen
  • Osoitenumero on valinnainen
  • Postinumero ja -toimipaikka on pakollinen
  • Osoitteen lisätieto on valinnainen

Postilokero-osoite

  • Postilokero-osoite on pakollinen
  • Postinumero ja -toimipaikka on pakollinen
  • Osoitteen lisätieto on valinnainen

Muu sijaintitieto

  • Postinumero ja -toimipaikka on valinnainen
  • Leveysaste on pakollinen
  • Pituusaste on pakollinen
  • Osoitteen lisätieto on valinnainen

Ulkomainen osoite 

  • Ulkomainen osoite vapaatekstinä on valinnainen
  • Maa (maakoodi), jossa osoite sijaitse, on pakollinen


PTV:n tietosisällön tunnisteet

Content id - PTV:n sisäinen tunnus

Sisällön yksilöivä, PTV:n generoima tunniste. Pysyy aina samana, vaikka sisällöstä tulee uusia versioita.

  • Content id on uniikki PTV:n saman sisältötyypin sisällä

Content id - käyttö päivityksissä

  • Content id:tä käytetään sisällön päivittämiseen API:n PUT-metodeilla

Version id -versiotunniste

Sisällön version yksilöivä PTV:n generoima tunniste. Kaikilla saman sisällön versioilla on sama content id ja eri version id.


PTV:n tietosisällön ulkoinen tunniste

ExternalId - ulkoinen tunniste

Sisällön yksilöivä, ulkoisen lähdejärjestelmän tunniste.

  • External id on uniikki PTV:n saman organisaation ja sisällön tyypin sisällä

Esimerkit sisältötyypeittäin:

  • Organisaatio: jokaisella organisaatiolla on oltava oma uniikki externalId. Se voi olla sama kuin jonkin palvelun tai kanavan ExternalId.
  • Palvelu: jokaisella palvelulla on oltava oma uniikki externalId. Se voi olla sama kuin jonkin organisaation tai kanavan ExternalId.
  • Asiointikanava: jokaisella asiointikanavalla on oltava oma uniikki externalId. Se voi olla sama kuin jonkin organisaation tai palvelun ExternalId.
  • Poikkeus: eri asiointikanavatyypit (esim. puhelinkanava ja palvelupiste) eivät saa käyttää samaa ExternalIdtä.

ExternalId - käyttö päivityksissä

  • ExternalId:tä voidaan käyttää myöhemmin sisällön päivittämiseen API:n PUT-metodeilla.
  • Jos externalId:tä ei anneta luontivaiheessa, käyttäjä ei voi lisätä sitä myöhemmin eikä käyttää sitä PUT-metodeissa. Huom. tämä kehitystiimillä pohdittavana, toteutetaanko näin versiossa V12.






Päivitetty: 30.3.2026

Oletko tyytyväinen tämän sivun sisältöön?