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 ryhti@syke.fi.
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
Alla olevan aikataulun avulla pystyy seuraamaan testirajapintojen valmistumista ja arvioimaan, milloin kehitystyö muissa järjestelmissä kannattaa aloittaa.
| Endpoint | Status | Status päivitetty |
|---|---|---|
| BuildingObject | Hyväksymistestauksessa | 5.12.2023 |
| BuildingPermit | Hyväksymistestauksessa | 5.12.2023 |
| DemolitionPermit | Hyväksymistestauksessa | 12.1.2024 |
| DeviationPermit | Hyväksymistestauksessa | 12.1.2024 |
| LandscapeWorkPermit | Hyväksymistestauksessa | 12.1.2024 |
| PermanentIdentifiers | Valmis | 5.12.2023 |
| Endpoint | Status | Status päivitetty |
|---|---|---|
| LocalDetailedPlanMatter | Tuotantovalmius | 30.1.2024 |
| LocalMasterPlanMatter | Tuotantovalmius | 30.1.2024 |
| RegionalPlanMatter | Tuotantovalmius | 30.1.2024 |
| Endpoint | Status | Status päivitetty |
|---|---|---|
| Document | Valmis | 5.12.2023 |
| Status | Valmis | 5.12.2023 |
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.