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.
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 [email protected].
Kaavoituksen rajapintakuvaukset on julkaistu tuotantokäyttöön. Rajapinnoista kerätään palautetta kehittäjiltä ja kumppanitestaajilta, jonka perusteella rajapintoja voidaan vielä muuttaa.
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 rajapintakuvauksia kehitetään. Rajapinnoille ei ole vielä määritelty tarkkaa julkaisuajankohtaa.
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ä.
- Yleiset tietomääritykset ja laatusäännöt
- Rakentamislupa ja rakennuskohde, rajapintojen toiminnallisuudet
- Rakennustietojen validointisäännöt ja paluuarvot
- Kaavatietomallin tietomääritykset
- Kaavatietomallin elinkaari- ja laatusäännöt
- Tontijaon tietomääritykset
- Tonttijaon elinkaari- ja laatusäännöt
- Alueidenkäytön rajoitusten tietomääritykset
- Alueidenkäytön rajoitusten elinkaari- ja laatusäännöt
- Rakennusjärjestyksen tietomääritykset
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.
| Rajapinta | Endpoint | Ryhti-kehitystiimin status | Kumppaneiden testattavissa | Status päivitetty |
|---|---|---|---|---|
| Asemakaava | LocalDetailedPlanMatter | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Yleiskaava | LocalMasterPlanMatter | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Maakuntakaava | RegionalPlanMatter | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Tiedostojen lataaminen | UploadedFile | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Tonttijako | BindingPlotDivisionMatter | Tuotantoversio julkaistu | Heti | 11.12.2024 |
| Alueidenkäytön rajoitukset | LandUseRestrictionMatter | Testiversio julkaistu | Heti | 11.12.2024 |
| Rakennusjärjestys | BuildingOrdinance | Tuotantoversio julkaistu | Heti | 11.12.2024 |
| Kaavojen validointipalvelu | Ryhti Plan Public Validate API | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Rajapinta | Ryhti-kehitystiimin status | Kumppaneiden testattavissa | Status päivitetty |
|---|---|---|---|
| Kaavojen sisääntuontikäyttöliittymä: asemakaava | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Kaavojen sisääntuontikäyttöliittymä: yleiskaava | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Kaavojen sisääntuontikäyttöliittymä: maakuntakaava | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Asemakaavan seurantalomake | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Tiedostojen lataaminen | Tuotantoversio julkaistu | Heti | 20.11.2024 |
| Rakennusjärjestys | BuildingOrdinance | Tuotantoversio julkaistu | Heti |
| Karttapalvelu | Kehityksessä | Q1/2025 | 11.12.2024 |
| Kaavojen validointipalvelu | Tuotannossa | Heti | 20.11.2024 |
| 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 |
| Rajapinta | Ryhti-kehitystiimin status | Kumppaneiden testattavissa | Status päivitetty |
|---|---|---|---|
| Karttapalvelu | Kehityksessä | Q1/2025 | 10.12.2024 |
| Rakennustietojen muokkauskäyttöliittymä | Ei toteuteta vuonna 2024 | - | 22.4.2024 |