Metaxin uusi rajapinta nyt käyttöön myös loppukäyttäjille

Fairdata-kokonaisuuteen kuuluu tutkimusaineistojen metatietovaranto Metax, jonka sisältämät julkaistujen aineistojen kuvailutiedot näkyvät Etsin-palvelussa ja Tiedejatutkimus.fi-portaalissa. Metax toimii tietovarantona muiden Fairdata-palvelujen taustalla, mutta sinne voi myös syöttää ja hakea aineistojen kuvailutietoja rajapinnan (METAX REST API) yli sen sijaan, että käyttäisi graafista Qvain-työkalua ja Etsin-palvelua. Aineistokuvauksia voi syöttää ja hakea joko yksittäinen loppukäyttäjä tai tietojen syöttö ja haku voi olla toteutettu koneelliseksi integraatioksi organisaation oman metatietovarannon ja Metaxin välille.

Uusi API-versio (V3) on nyt julkaistu myös loppukäyttäjille

Uudistettu rajapinta otettiin käyttöön toukokuussa 2024 organisaatioasiakkaille, ja nyt se on avattu myös loppukäyttäjille. Katso aiempi uutinen aiheesta täältä.

Miten uusi versio vaikuttaa loppukäyttäjiin?

Jos käytät aineistosi kuvailuun Qvain työkalua, eikä Metaxin API-käyttö ole tuttua, uuden version käyttöönotto ei vaikuta sinuun.

Kun aineistoja kuvataan ja julkaistaan (sekä muokataan), API-versioiden käyttöön liittyy joitakin pieniä rajoituksia. Pääsääntö on, että V3-versiolla voit muokata mitä tahansa aineistoja, mutta kun käytät V3-versiota, et voi enää palata vanhempiin versioihin (V1/V2).
Qvain käyttää automaattisesti versiota V3, ja näin ollen Qvaimella luotua tai muokattua aineistoa voidaan muokata vain versiolla V3.

Yhteenvetona, jos käytät:

  • Ainoastaan Qvainta aineistojen kuvaamiseen, julkaisemiseen ja muokkaamiseen: EI VAIKUTUSTA
  • Ainoastaan Metax API:a aineistojen kuvaamiseen, julkaisemiseen ja muokkaamiseen: EI VAIKUTUSTA
    • Voit vapaasti valita, käytätkö versiota V1/V2 vai V3
    • HUOM! Kun olet käyttänyt V3:ta aineiston luomiseen/muokkaamiseen, voit muokata aineistoa vain V3:lla.
  • Metax API:a aineistojen luomiseen, ja ainoastaan Qvainta niiden muokkaamiseen: EI VAIKUTUSTA
    • Voit vapaasti valita, käytätkö aineiston luomiseen versiota V1/V2 vai V3.
  • Metax API:a aineiston luomiseen, ja sen jälkeen Qvainta sekä Metax API:a sen muokkaamiseen:
    • Qvaimella muokkaamisen jälkeen, voit käyttää muokkaamiseen vain API V3:a tai Qvainta.
  • Qvainta aineiston luomiseen, ja sen jälkeen Metax API:a sen muokkaamiseen:
    • Sinun on käytettävä uutta versiota V3 aineiston muokkaamiseen.

Aineistojen noutamisen Metaxista voi tehdä millä tahansa versiolla. Kaikki aineistot (riippumatta siitä, millä versiolla ne on luotu/muokattu) löytyvät kaikilla API-versioilla.

Metax dokumentaatio: https://metax.fairdata.fi/v3/docs/