Tällä sivulla on kuvattu miten alustan rajapintoja voidaan hyödyntää ulkopuolisissa integraatioissa, kuten koodistojen, tietomallien tai sanastojen lataamisessa omaan tietojärjestelmään tai aineistojen automaattiseen päivittämiseen yhteentoimivuusalustalle.

Tokenin tilaaminen

Rajapintoja voidaan käyttää JWT-tokenin avulla, joka voidaan tilata ryhmienhallintapalvelusta (https://rhp.suomi.fi) käyttäjätietojen alta:

Tilattu token näytetään tokenia luotaessa vain kerran, mutta sen voi tarvittaessa poistaa ja luoda uudelleen.

Rajapintojen Open API kuvaukset

Harmonisoidut rajapinnat

Kaikissa sovelluksissa on harmonisoitu Integration-rajapinta, jonka avulla voidaan hakea tietosisältöjen perustietoja samassa formaatissa. Integration API:t tukevat sekä GET että POST tyyppisiä kyselyjä, joiden avulla alustalta voidaan kysellä lista kaikista tuotoksista (Containers) ja niissä määriteltävistä resursseista (Resources). 

Containers API - /api/v1/integration/containers

API listaa kaikki julkaistut aineistot (containers). 

GET rajapinta esimerkki:

curl -X GET "http://tietomallit.suomi.fi/datamodel/api/v1/integration/containers" -H "Content-Type: application/json" -H "Authorization: Bearer INSERT_TOKEN_HERE"

POST rajapinta esimerkki:

curl -X POST "http://tietomallit.test.yti.cloud.vrk.fi/datamodel/api/v1/integration/containers" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"searchTerm\":\"tieto\",\"pageSize\":5,\"pageFrom\":0}" -H "Authorization: Bearer INSERT_TOKEN_HERE"

Resources API - /api/v1/integration/resources

API listaa kaikki tuotoksissa julkaistut resurssit (resources). 

GET rajapinta esimerkki:

curl -X GET "http://localhost:8084/datamodel/api/v1/integration/resources?after=2018-11-19T13%3A26%3A13.057Z&before=2019-01-19T13%3A26%3A13.057Z" -H "Authorization: Bearer INSERT_TOKEN_HERE"

POST rajapinta esimerkki:

curl -X POST "http://localhost:8084/datamodel/api/v1/integration/resources" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"status\":[\"DRAFT\",\"VALID\"],\"after\":\"2018-11-19T14:05:19.451Z\",\"before\":\"2019-01-19T14:05:19.451Z\"}" -H "Authorization: Bearer INSERT_TOKEN_HERE"

Aineiston resolvointi uri:n avulla

Harmonisoidut integration-rajapinnat tarjoavat yksinkertaisen tavan listata aineistot. Listauksen perusteella voidaan hakea tarkempia julkaisukohtaisia tietoja resolvoimalla aineisto URI-tunnuksen avulla.

Esimerkki aineiston URI osoitteen resolvoinnista:

curl -L -X GET --header 'Accept: application/json' 'http://uri.suomi.fi/datamodel/ns/att#'

Resolvoinnissa tuetut formaatit

Tällä hetkellä resolvoinnissa tuetaan seuraavia sovelluksia ja formaatteja

application/ld+json+context

Sovelluskohtaiset Export API:t

Sovelluksista voidaan exportoida aineistoja myös sovelluskohtaisten export API:en avulla.

Tietomallit:

Open API Dokumentaatio

Polku: /datamodel/api/v1/exportModel?uri=<http://...>

Sanastot:

TBD! Polut muutuvat!

/terminology/api/v1/export?uri=

Koodistot:

/codelist-api/api/v1/coderegistries/<rekisterin-tunniste>/codeschemes/<koodiston-tunniste>/?format=<excel|csv>