fi fi fi fi fi fi fi fi fi fi fi nds fr fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi it fi fi fi fi fi fi ur fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi de en en fi fi fi fi fi fi fi en fi fi fi fi en fi fr fi en fi en fi fi fi ceb lt fi en lt en ceb hbs_lat fi kn yue kn fi fi fi en fi fi fi ceb gu en ceb hbs_lat it kn yue kn fi fi en fi fi en fi fi fi fi fi es id fi ru en fi fi fi fi fi en fi fi fi fi en fi fi fi en fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi fi uk fi fi fi nl fi fi it fi fi fi
Collective Access - rajapinta — Avoimen tiedon keskus
Musiikin, taiteen ja kulttuurin tutkimuksen laitos
JYUniorit - Lasten ja nuorten yliopisto
Avoimen tiedon keskus > Blogi > OSC-tech > Collective Access - rajapinta
Collective Access - rajapinta Testaamme Collective Accessin rajapintaa https://osc.jyu.fi/fi/blogi/osc-tech/collective-access-rajapinta https://osc.jyu.fi/@@site-logo/logo.png
Collective Access - rajapinta
Testaamme Collective Accessin rajapintaa
Collective Accessin rajapinta on käyttökelpoinen.
Ensimmäinen testattava asia uuden verkkopalvelun (Collctive Accessin tässä tapauksessa) kokeilussa on sen REST-rajapinnan käyttökelpoisuuden selvittäminen. Vaikka koneille tarkoitetut rajapinnat eivät peruskäyttäjää juurikaan ilahduta, ovat ne kehittäjän/ylläpitäjän näkökulmasta niin tärkeitä, että niistä pitää blogissakin kertoa.
Miksi rajapinta on tärkeä?
Nykyaikainen REST-rajapinta on yksi tärkeimmistä kriteereistä melkeinpä mitä tahansa järjestelmää valittaessa. Erityisen tärkeää se on museotietojärjestelmän kohdalla.
Hyvä rajapinta helpottaa suuresti aineiston tuomista/viemistä/muokkaamista ja kaikkea sitä puljaamista, mitä aineistolle joudutaan tekemään. Ehkä halutaan luoda hyvin yksinkertainen lomake juuri tietynlaisen aineiston syöttöön. Tai ehkä meille tulee jatkuvasti aineistoa, joka pitää viedä mahdollisimman vähällä vaivalla suoraan kokoelmanhallintaan. Tai aineistosta halutaan reaalikaista analyysiä, jota järjestelmän omat raportointityökalut eivät osaa tehdä. Nämä kaikki voidaan toteuttaa rajapinnan kautta.
Hyvät rajapinnat luovat myös turvaa käyttäjille käyttöliittymäsuunnittelijoiden hirmuvaltaa vastaan: Jos järjestelmän oma käyttöliittymä on kökkö, niin se voidaan korvata kokonaan tai osittain omalla käyttöliittymällä. Tästä hyvänä esimerkkinä on digiarkistomme JYX, jossa olemme kehittäneet omia työnkulkuja JYXin rajapintojen päälle.
Collective Accessin rajapinta on käyttökelpoinen. Aineistosta saa tehtyä hakuja sekä fasettinäkymiä, ja aineiston muokkaaminen ja editoiminen onnistuu. Ainut esiin noussut rajoitus tiedoston lähettämisen puuttuminen. Tästä on tehty tiketti ja se luultavasti jossain vaiheessa toteutetaan.Toisaalta puute on suhteellisen helposti kierrettävissä oman toteutuksen kautta.
Seuraavassa on esimerkkejä rajapintakutsuista curl -ohjelmiston avulla.
Monet rajapinnan toiminnot vaativat kirjautumisen. Se tehdään seuraavasti:
Kutsu palauttaa tokenin, jonka avulla seuraavat kutsut voidaan autentikoida.
Kokotekstihaku toimii siten, että kerrotaan mistä perustyypistä halutaan hakea ja sitten hakusana (ei vaadi autentikointia):
Jos haluaa hakea vain tietystä kentästä, niin se tapahtuu seuraavasti:
Fasettihaut onnistuvat myös ja ne on dokumentoitu täällä.
Alla on yksinkertaisin mahdollinen uusi objekti, jolla on pelkästään id ja nimi:
"type_id":"26", // pakollinen, kertoo mitä tyyppiä kohde on
"name":"polkupyörän poljin"  // uuden kohteen nimi
Nyt voidaan luoda uusi kohde seuraavasti:
curl -XPUT http://localhost/providence/service.php/item/ca_objects?authToken=sinun_tokenisi_tähän -d @new.json
Monesti on kuitenkin tarvet tehdä monimutkaisempia kohteita. Käytännössä helpointa onkin tehdä ensin samantyyppinen kohde käyttöliittymän kautta ja hakea se sitten pohjaksi uudelle kohteelle.
curl -XGET 'http://localhost/providence/service.php/item/ca_objects/id/1?pretty=1&format=edit&authToken=sinun_tokenisi_tähän' > new.json
Tämä tallettaa kohteen tiedot tiedostoon new.json. Tätä voidaan käyttää uusien tietueiden luomisen pohjana (muista poistaa "object_id") tai tietojen muokkaamiseen.
Muutetaan seuraavaksi kohteen nimeä. Tee edit.json -niminen tiedosto ja kopioi alla olevan siihen.
Huomaa "remove_all_labels" -attribuutti. Tämä poistaa alta kaikki entiset nimet. Jos tätä ei ole, niin uusi nimi vain lisätään muiden jatkoksi.
Muutos toteutetaan kutsumalla REST-rajapintaa seuraavasti  (editoidaan objektia, jonka id on 1):
curl -XPUT 'http://localhost/providence/service.php/item/ca_objects/id/1?authToken=oma_tokenisi_tähän' -d @edit.json
Tarkempaa dokumentointia editoinnista löydät tästä.
JYU ja avoin tiede
Collective Access - rajapinta
Jyväskylän yliopiston kirjasto Lähde avautuu maanantaina 30.8. 24.08.2021
Ylistönrinteen kirjasto suljetaan muuton vuoksi to 24.6.2021 22.06.2021
Lähde-kirjaston ravintolapalveluiden toteuttajaksi valittiin Compass Group 28.05.2021
Rakennustyömaan viikkotiedote, viikko 21 26.05.2021
The renovated Library Building will have a science and art education centre open for public 21.05.2021
PL 35 (B, Lähde)
Seminaarinkatu 15 (B, Lähde)
Yliopiston erillislaitokset ja palvelut
Monikielisen akateemisen viestinnän keskus Movi