Skip to content

Rakennetun ympäristön tietojärjestelmän rajapintojen kuvaukset.

Notifications You must be signed in to change notification settings

sykefi/Ryhti-rajapintakuvaukset

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ryhti-rajapintakuvaukset

Tutustu rakennetun ympäristön tietojärjestelmän rajapintojen kuvauksiin, jotka kertovat tietojärjestelmän validointi- ja tallennusrajapintojen toteutustavasta.

Main-haarassa on julkaistu tuotantokäyttöön otettujen palveluiden rajapintakuvaukset. Dev-haarasta löydät kehitysversiot kuvauksista. Kehitysversiota ei versioida, vaan muutokset näkyvät GitHub-repositoryn muutoshistoriasta. Myös kuvauksiin liittyvä dokumentaatio täydentyy.

Kommentointi

Rajapintakuvauksiin tutustuminen edellyttää aiempaa kokemusta rajapintojen toteutuksesta ja JSON-tiedostoista. Kuvaukset on tarkoitettu erityisesti teknisille järjestelmäkehittäjille yrityksissä, kunnissa ja muissa organisaatioissa.

Voit lähettää palautetta ja kysymyksiä rajapintakuvauksista osoitteeseen ryhti@syke.fi.

Kaavoituksen rajapintakuvaukset

Kaavoituksen rajapintakuvaukset on julkaistu tuotantokäyttöön. Rajapinnoista kerätään palautetta kehittäjiltä ja kumppanitestaajilta, jonka perusteella rajapintoja voidaan vielä muuttaa.

Kaavoituksen julkiset rajapinnat

Rakennetun ympäristön tietojärjestelmän ensimmäiset julkiset rajapinnat kaavoituksen kaavasuunnitelmien validointiin on julkistettu osoitteessa https://api-developer.ymparisto.fi/. Rajapinnan käyttö edellyttää rekisteröitymistä ja API avaimen käyttöä.

Lisää tietoa Suomen ympäristökeskuksen sovelluskehittäjäportaalissa https://api-developer.ymparisto.fi/

Rakentamisen rajapintakuvaukset

Rakentamisen rajapintakuvauksia kehitetään. Rajapinnoille ei ole vielä määritelty tarkkaa julkaisuajankohtaa.

OpenApi-kuvaukset

Rajapintojen kuvaukset löytyvät kansiosta OpenApi. OpenApi-kuvaukset ovat JSON-muodossa ja niitä voi katsella esim. https://editor.swagger.io/ sivuston avulla kopioimalla JSON-tiedoston sisällön sinne.

Suorat linkit kuvauksiin Githubissa

Suomi.fi palveluväylään julkaistut kuvaukset

OpenAPI-spesifikaatio on määrittelykieli APIen kuvaamiseen. OpenAPI-kuvaus on standardoitu tapa määritellä API, mikä auttaa muita ymmärtämään APIn toimintaa ja kyvykkyyksiä. OpenAPI on riippumaton ohjelmointikielestä.

Rajapintoihin tutustumista tukevat dokumentit

Aikataulu: milloin rajapinnat ja käyttöliittymät ovat testattavissa?

Alla olevan aikataulun avulla pystyt seuraamaan Ryhti-järjestelmän rajapintojen ja käyttöliittymäpalveluiden valmistumista. Taulukko auttaa myös arvioimaan, milloin kehitys- ja testaustyö muissa järjestelmissä kannattaa aloittaa.

Alueidenkäytön rajapintakäyttö

Rajapinta Endpoint Ryhti-kehitystiimin status Kumppaneiden testattavissa Status päivitetty
Asemakaava LocalDetailedPlanMatter Tuotantoversio julkaistu Heti 29.2.2024
Yleiskaava LocalMasterPlanMatter Tuotantoversio julkaistu Heti 29.2.2024
Maakuntakaava RegionalPlanMatter Tuotantoversio julkaistu Heti 29.2.2024
Tiedostojen lataaminen UploadedFile Tuotantoversio julkaistu Heti 29.2.2024
Tonttijako BindingPlotDivisionMatter Kehityksessä Kesäkuu 2024 22.4.2024
Maankäyttörajoitukset - Määrittelyssä Q4/2024 22.4.2024
Kaavojen validointipalvelu Ryhti Plan Public Validate API Tuotantoversio julkaistu Heti 29.2.2024

Alueidenkäytön käyttöliittymäkäyttö

Rajapinta Ryhti-kehitystiimin status Kumppaneiden testattavissa Status päivitetty
Kaavojen sisääntuontikäyttöliittymä: asemakaava Kehityksessä Yksittäisen suunnitelmatiedoston tuominen testattavissa heti. Lomake asiakirjoihin ja päätöksiin liittyvien tietojen tuomiseen tulossa kesäkuussa 2024. 22.4.2024
Kaavojen sisääntuontikäyttöliittymä: yleiskaava Kehityksessä Yksittäisen suunnitelmatiedoston tuominen testattavissa heti. Lomake asiakirjoihin ja päätöksiin liittyvien tietojen tuomiseen tulossa kesäkuussa 2024. 22.4.2024
Kaavojen sisääntuontikäyttöliittymä: maakuntakaava Kehityksessä Yksittäisen suunnitelmatiedoston tuominen testattavissa heti. Lomake asiakirjoihin ja päätöksiin liittyvien tietojen tuomiseen tulossa kesäkuussa 2024. 22.4.2024
Tiedostojen lataaminen Tuotannossa Heti 29.2.2024
Karttapalvelu Kehityksessä Q3-Q4/2024 22.4.2024
Kaavojen validointipalvelu Tuotannossa Heti 29.2.2024

Rakennusluvituksen rajapintakäyttö

Rajapinta Endpoint Ryhti-kehitystiimin status Kumppaneiden testattavissa Status päivitetty
Rakennuskohde BuildingObject Hyväksymistestattu Heti 22.4.2024
Rakentamislupa BuildingPermit Hyväksymistestattu Heti 22.4.2024
Purkamislupa DemolitionPermit Hyväksymistestattu Heti 22.4.2024
Poikkeamislupa DeviationPermit Hyväksymistestattu Heti 22.4.2024
Maisematyölupa LandscapeWorkPermit Hyväksymistestattu Heti 22.4.2024
Pysyvät tunnukset PermanentIdentifiers Valmis Heti 29.2.2024
Tiedostojen lataaminen - - - 29.2.2024

Rakennusluvituksen käyttöliittymäkäyttö

Rajapinta Ryhti-kehitystiimin status Kumppaneiden testattavissa Status päivitetty
Karttapalvelu Kehityksessä Q3-Q4/2024 22.4.2024
Rakennustietojen muokkauskäyttöliittymä Ei toteuteta vuonna 2024 - 22.4.2024

Huomioita

Tonttijakojen ja maankäyttörajoitusten kehitystyö on kesken. Rajapintakuvaukset valmistuvat Q2/2024.

Ensimmäinen versio kaavatietojen käyttöliittymästä on valmistunut. Käyttöliittymän kehitystä jatketaan siten, että ennen kesää julkaistavassa versiossa voi lomakenäkymän kautta tuoda asiakirjoihin ja päätöksiin liittyvät tiedot, jolloin vain kaavasuunnitelma pitää olla JSON-muodossa.