Suomi.fi-palvelutietovaranto Kaikki oleellinen julkishallinnon palveluista yhdessä paikassa. PTV-rajapintojen ajankohtaiset asiat

Transkriptio

1 Suomi.fi-palvelutietovaranto Kaikki oleellinen julkishallinnon palveluista yhdessä paikassa PTV-rajapintojen ajankohtaiset asiat

2 Tavoitteet ja sisältö Tavoitteet Tiedottaa PTV:n IN-rajapinnan seuraavaan versioon suunnitelluista muutoksista Vastata käyttäjien kysymyksiin

3 PTV API-versiossa 7 tulevat muutokset

4 Ylätason muutokset Organisaatio Organisaatio metodien muutokset (POST/PUT/GET): Laskutustietojen kuvaaminen ja näyttäminen (julk 1.8) Osoitetietojen määrittely muuttunut (esimerkki katso viimeinen sivu) Katuosoite, postilokero-osoite, ulkomainen osoite omissa lohkoissa Pääorganisaatiotieto näkyviin GET-metodilla sourceid kenttä lisätty GET Organization/{id} metodiin tieto tulee näkyviin vain kirjautuneelle käyttäjälle, muutoin Null.

5 Ylätason muutokset Palvelu Palvelun metodien muutokset (POST/PUT/GET): Pohjakuvauksella ehdotettujen kanavien liittäminen (liitoksen hyväksyminen) sourceid kenttä lisätty GET Service/{id} metodiin tieto tulee näkyviin vain kirjautuneelle käyttäjälle, muutoin Null. Liitoksen tekeminen Palvelun kautta (ei mahd. lisätietojen antamista) Luodut liitokset näkyvät GET Service/{id} metodilla Näkyviin tulevat myös yhteispalvelupisteiden uudet kentät

6 Ylätason muutokset Kanavat Kanavien metodien muutokset (POST/PUT/GET): sourceid kenttä lisätty GET ServiceChannel/{id} metodiin tieto tulee näkyviin vain kirjautuneelle käyttäjälle, muutoin Null. Sijaintietojen (osoitetietojen) määrittely muuttunut (lisää esimerkki) Tulostettava lomake: Katuosoite, Postilokero-osoite, Toimitustieto sanallisesti omissa lohkoissa Palvelupiste: Katuosoite, Postilokero-osoite, liikkuva kanava, Ulkomainen osoite omissa lohkoissa >> Katso käsittelysäännöt dialta lisätietoa o Monta sijaintia (ent. Liikkuva kanava) julkaisu 1.8 Liitoksen tekeminen Kanavan kautta (ei mahd. lisätietojen antamista) Luodut liitokset näkyvät GET ServiceChannel/{id} metodilla Näkyviin tulevat myös yhteispalvelupisteiden uudet kentät

7 Ylätason muutokset Liitokset Liitokset metodien muutokset (POST/PUT/GET): Liitokset siirretty omaksi osiokseen Swaggerissa api/v7/connection Palvelun ja Palvelupisteen liitokselle voidaan antaa aukioloaika ja yhteystieto lisätietoja Lisätty mahdollisuus päivittää liitostietoja kanavan kautta (id) PUT /api/v7/connection/servicechannelid/{servicechannelid} Liitoksen GET metodeissa yhteispalvelupisteiden kentät uutena tietona

8 Vanhat metodit, tärkeimmät muutokset Organisaatio Tiivistelmä kenttä lisätty Laskutusosoitetiedot lisätty (julk. 1.8) Osoite rakenne muuttunut Palvelu Päävastuu ja muut vastuuorganisaatiot rakennetta muutettu Aukioloajat ja yhteystiedot näkyviin palveluun liitetyn asiointikanavassa tiedoissa Palveluluokkien Finto-kuvaus näkyville Kanava (Tulostettava lomake & Palvelupiste) Osoite rakenne muuttunut

9 Käsittelysääntöjä Lisätty tarkastus: PTV-pääkäyttäjä voi lisätä alaorganisaation vain sen organisaation alle, johon hänelle on oikeudet Lisätty tarkastus: organisaation tai alaorganisaation arkistointi ei sallittu, jos niille on kuvattu palveluja tai kanavia. Alla olevat metodit palauttavat jatkossa vain kysytyn tiedon ID:n ja nimen (lista) GET Service/serviceChannel/{serviceChannelId} GET ServiceChannel/type/{type} GET ServiceChannel/organization/{organizationId} GET ServiceChannel/organization/{organizationId}/type/{type} Palvelupisteen sijaintitiedot Yksi sijainti (ent. katuosoite) Monta sijaintia (ent. liikkuva palvelupiste) julk. 1.8 Sijainti ulkomailla (ent. ulkomainen osoite)

10 Uudet metodit CodeList viisi uutta metodia. Voidaan palauttaa käytettyjä koodistoja (Kunta-, Maa-, postinumero-, kieli-, Maakunta-, Sairaanhoitopiiri- sekä yritysseutualuekoodit) Common kaksi uutta metodia. Ensimmäinen palauttaa tiedot organisaation julkaistuista palveluista ja kanavista (id ja nimi). Toinen palauttaa samat tiedot mutta kuntatieto rajauksella ServiceCollection - Palvelukokonaisuus Lisäksi Swagger sisältää uusia metodeja, joiden käyttö on rajoitettu metodeissa on tästä maininta.

11 Tuetut versiot Julkaisun numero Julkaisun päivä Tuetut rajapintaversiot V5, V4, V3, V2 Lisätieto V6, V5, V4, V V6, V5, V * V7, V6, V5, V4 Rajapintaversiota V4 ei tueta - voi käyttää V7, V6, V5 Ei uutta raja-pintaversiota (alustava) (alustava) V8, V7, V6, V5 Rajapintaversiota V5 ei tueta - voi käyttää Ei uutta raja-pintaversiota (alustava suunnitelma)

12 Esimerkki osoitetietokentistä "addresses": [ { "type": "string", "subtype": "string", "postofficeboxaddress": { "postofficebox": [ {"value": "string", "language : string } ], "postalcode": "string", "municipality": "string", "additionalinformation": [ { "value": "string", "language": "string" } ] }, "streetaddress": { "street": [ { "value": "string", "language": "string" } ], "streetnumber": "string", "postalcode": "string", "municipality": "string", "additionalinformation": [ { "value": "string", "language": "string" } ], "latitude": "string", "longitude": "string" }, "foreignaddress": [ { "value": "string", "language": "string" } ], "country": "string" } ],

13 Liitokset Palvelu Liitos Asiointikanava Perheneuvola palvelut Perhe- ja ryhmäterapia Ma, ti, to 10:00-14:00 Sisäänkäynti 3 kerros Hammashoidon päivystys Lastensuojelun palvelut Työterveys palvelut Hammashoitola Ma-pe 8:00 16:00 Lastensuojelu Ma-pe 9:00 15:30 Vain ajanvarauksella Työterveyden hoitaja Ma-pe 8:00 16:00 Ilmoittautuminen 1 kerros Terveyskeskus Normaalit aukioloajat: Ma-pe 8:00 18:00 Vahtimestari

14 PTV OUT rajapinta

15 Palvelujen hakeminen GET service/{id} metodi tuo pohjakuvaukselta vain ne tiedot näkyviin, jotka ovat pakollisia ja joita käyttäjä ei ole itse syöttänyt: Palvelutyyppi Kohderyhmä Palveluluokka Asiasanat Pohjakuvauksen tiedot haetaan metodilla GET GeneralDescription/{id} Yhden organisaation palvelujen ja asiointikanavien hakeminen Hae organisaation palvelut (id, y- tunnus, oid) Palvelun tiedot, pohjakuvaus id, listaus kanavista: id, nimi Listaus palveluista: Id, nimi Hae jokaisen palvelun tiedot (id) Hae pohjakuvauksen tiedot (id) Hae jokaisen kanavan tiedot (id)

16 Ennakko kysymyksiä Onko tulossa muutoksia rajapintaan jotka vaikuttaa nykyisiin toteutuksiin? Vanhat V5, V6 versiot säilyvät ennallaan eli ei tule niihin muutoksia. V7 muuttaa vanhojakin metodeja. Rautalangasta: Mitä kunnan tulee tehdä saatuaan Palvelutietovarannon valmiiksi? Ylläpitää tietoja päivittää säännöllisin välein ja tarkastaa ettei tiedoissa ole virheitä Miten rajapintojen vanhoja versiota tuetaan? Eli millainen elinkaari niissä on. Uusin + kaksi edellistä. Sovimme jo, että jätetään v4 näkyviin mutta ei tueta sitä. Olisin kiinnostunut kuulemaan, onko muuallakin kuin Varsinais-Suomessa ollut vaikeuksia saada rajapintaratkaisun tekninen toteuttaja ymmärtämään PTV:n ominaisuuksia ja toimituspolitiikkaa? Suomi.fi laaduntarkkailu on kiinnittänyt tähän huomiota ja mietimme ratkaisua, jolla sovellustoimittajia voidaan auttaa ymmärtämään PTV:n tietomalli ja ohjeistamaan omia käyttäjiään oikein Käytännön kokemuksia kuulisin onko toiminut ja onko hyötyä lähinnä OUT-rajapintaa koskien OUT-rajapinnan käyttäjistä VRK:lla ei ole saman lailla tietoa kuin IN-rajapinnan käyttäjistä. Suurin hyödyntäjä on Suomi.fiverkkopalvelu. Muita ovat tassa.fi, Ruokolahden kunta, Tampereen palvelut (pilotti) Lokilta selviää että esim. syyskuun aikana on GET kutsuja ollut noin 9 miljoonaa 7-version muutokset verrattuna 5-versioon 7-version aikataulu Uudet metodit, Liitoksien siirtäminen omaan osioon, liitoksen lisätiedot, osoiterakenteen muuttuminen Julkaisu lokakuu 2017, versiotiedote lähetetään viikkoa ennen versiopäivitystä.

17 Liitemateriaalia

18 IN API rajapinnassa 1/2 Järjestelmäpääkäyttäjä PTV pääkäyttäjä PTV ylläpitäjä API käyttäjä Lisätietoa Pääorganisaation luonti Ei sallittu Ei sallittu Ei sallittu Ei sallittu Vain Palvelunhallinnan kautta (tulossa) Pääorganisaation arkistointi* Sallittu Ei sallittu Ei sallittu Ei sallittu * Arkistointi poistaa organisaation suomi.fi verkkopalvelusta Pääorganisaation tietojen muokkaus (lisäys/muutos/poisto) Organisaatiorakenteen (puun) muutokset Sallittu Sallittu Ei sallittu Sallittu Ei sallittu Ei sallittu Ei sallittu Ei sallittu Alaorganisaation luonti Sallittu Sallittu Ei sallittu Sallittu Alaorganisaation arkistointi Sallittu Sallittu Ei sallittu Sallittu Alaorganisaation tietojen muokkaus (lisäys/muutos/poisto) Palvelujen tai asiointikanavien luonti Palvelujen tai asiointikanavien arkistointi Sallittu Sallittu Ei sallittu Sallittu Sallittu Sallittu Ei sallittu Sallittu Sallittu Sallittu Ei sallittu Sallittu

19 IN API rajapinnassa 2/2 Palvelu tai asiointikanavien tietojen muokkaus (lisäys/muutos/poisto) Järjestemä pääkäyttäjä PTV pääkäyttäjä PTV ylläpitäjä API käyttäjä Lisätietoa Sallittu Sallittu Ei sallittu Sallittu Liitosten luonti Sallittu Sallittu Ei sallittu Sallittu Liitosten poisto Sallittu Sallittu Ei sallittu Sallittu Liitosten lisätietojen muokkaus (lisäys/muutos/poisto) Sallittu Sallittu Ei sallittu Sallittu Pohjakuvausten luonti Sallittu Ei sallittu Ei sallittu Ei sallittu Pohjakuvausten poisto Sallittu * Ei sallittu Ei sallittu Ei sallittu Pohjakuvausten tietojen muutokset Sallittu * Ei Sallittu Ei sallittu Ei sallittu Pohjakuvausten käyttö palveluissa Sallittu Sallittu Ei sallittu Sallittu

20 Lisätietoja esuomi.fi ja PTV-in rajapinta materiaalia löytyy esuomi.fistä PTV:n versiotiedotteet: IN-rajapinnan testausohje löytyy esuomi.fin ladattavista aineistoista täältä: IN-rajapinta Apin kuvaukset löytyvät osoitteesta PTV-rajapintojen skeemat ovat saatavilla swaggerissa osoitteessa HUOM! Swaggerissa on valittava haluttu versio erikseen. Pohjakuvausten tiedot ja tuotantoympäristön ID:t löytyvät: 20

21 Kiitos! Yhteydenotot: Lisätietoja: PTV-video: 21