...
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
| Sovellus | Kuvaus | Linkki |
|---|---|---|
| Tietomallit | Tietomallit-sovelluksen API -kuvaus | https://tietomallit.suomi.fi/swagger/ |
| Koodistot | Koodistot-sovelluksen API -kuvaus | https://koodistot.suomi.fi/swagger/ |
| Sanastot | Sanastot-sovelluksen API -kuvaus | https://sanastot.suomi.fi/swagger/ |
Harmonoisoidut 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 tuotokset (containers).
...
| Code Block |
|---|
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).
...
| Code Block |
|---|
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" |
Resolvointi uri:n avulla
Harmonisoidut integration-rajapinnat tarjoavat yksinkertaisen tavan listata julkaisut ja resurssit. Listauksen perusteella voidaan hakea tarkempia julkaisukohtaisia tietoja resolvoimalla julkaisun tai resurssin uri-osoite:
...