Kehittäjille
Metsänhoidon suositukset -järjestelmä on kaikille avoin tietolähde, josta voi siirtää metsänhoidon suositusten ajantasaista sisältöä ulkopuolisiin tietojärjestelmiin, sovelluksiin ja verkkosivustoille avoimen rajapinnan kautta. Käytössä ovat GraphQL API ja REST API. Palvelu on maksuton kaikille, myös kaupallisille toimijoille. Metsänhoidon suositusten sisältöön ja rakenteeseen voi tutustua web-käyttöliittymän kautta osoitteessa www.metsänhoidonsuositukset.fi(extern länk), mikä helpottaa rajapinnan hyödyntämistä.
Rajapintapalvelu
Rajapinnat löytyvät osoitteesta api.metsanhoidonsuositukset.fi(extern länk)
Katso myös: Käyttöehdot(extern länk)
Tukipalvelut kehittäjille
Rajapinnoista voi esittää kysymyksiä Slack-palvelussa ylläpidettävällä tukikanavalla MHSDigi(extern länk).
Lisätietoja metsätietopalvelujen kehittäjille antavat ylläpitäjät Tapiossa: mhspalaute@tapio.fi, kati.kontinen@tapio.fi tai henry.schneider@tapio.fi.
Hakutoiminnot rajapinnassa
Metsänhoidon suositusten rakenne koostuu neljästä osiosta:
- Kuvaus-osiossa annetaan yleinen kuvaus toimenpiteestä ja sen tavoitteista, hyödyistä sekä vaikutuksista.
- Päätöksenteko-osiossa kerrotaan aihealueeseen liittyen ns. läpileikkaavat teemat, esimerkiksi luonnon monimuotoisuuden tai vesiensuojelun huomioiminen kyseisessä toimenpiteessä.
- Toteutus-osiossa kuvataan toimenpiteen toteutus yksityiskohtaisesti.
- Lisätietoa-osiosta löytyvät suositusten laadinnassa käytetyt lähdeviitteet.
"Suositukset aiheittain" kokoaa jonkin aihealueen sisällöt yhteen helposti luettavaksi kokonaisuudeksi.
Palvelun rajapinnasta kyseiset osiot löytyvät nimillä:
- Kuvaus = Operation description
- Päätöksenteko = Good practice
- Toteutus = Realisation
- Lisätietoa = Reference
- Kaikkea kuvamateriaalia voi hakea vapaasti = Media
- Suositukset aiheittain = Category.
Rajapintahakujen tekeminen
Rajapintoja on rakennettu kaksi: GraphQL API ja REST API. Tässä yhteydessä kuvataan ainoastaan REST APIn käyttöä lyhyesti.
Jos haetaan tietoa esimerkiksi harvennuksesta:
REST API: Otsikko operation-description, valitse GET-painike kohdassa /operation-descripions ja sen jälkeen Try it out.
Rajapinnasta haetaan kaikki toimenpiteen kuvaukset ja sen jälkeen poimitaan kyseisen toimenpiteen kuvauksen id ja haetaan sillä: GET /operation-descriptions/ {id}. Haku voidaan tehdä myös työlajikoodilla: vaihda alalaidasta ID valinnaksi operation TypeCode.
ID versus operationTypeCode
ID on järjestelmän sisäinen ID, jota ei voi tietää ennalta. Mikäli kutsuja haluaa ketjuttaa, esimerkiksi hakemalla ensin metsätietostandardin koodilla toimenpiteen kuvauksen (haku by = operationTypeCode esim https://api.metsanhoidonsuositukset.fi/v1/operation-descriptions/100?by=operationTypeCode(extern länk) ), saa vastauksena kokonaisuuden, jossa on mukana myös järjestelmän sisäisiä ID:itä. Näitä voi käyttää jatkohauissa esimerkiksi toteutuksien kohdalla.
Yleinen huomio metsätietostandardin koodistoista: Tällä hetkellä haku onnistuu vain yhdistelmäkoodistolla OperationTypeType, jossa koodit on yhdistetty kyseisiin suosituksiin. Metsänhoidon suositusten sisältöä ja rajapintaa kehitetään edelleen, jotta eri metsätietostandardikoodistoilla haku mahdollistuisi.