REST API za dostop uporabnikov do podatkov SICRIS

Uporabniške zahteve REST za dostop do podatkov SICRIS, dostopne prek splošnega naslova:

https://cris.cobiss.net/{system}/{language}/service

Za slovenski sistem SICRIS se pri naslavljanju zahtev tako uporabi naslov:

https://cris.cobiss.net/ecris/si/sl/service

Osnovno povezavo je treba za dostop do razpoložljivih metod za avtorizacijo in dostop do podatkov entitet SICRIS dopolniti z naslavljanjem posameznih metod in iskalnimi parametri, kot je opisano v nadaljevanju.

Avtorizacija

Za dostop do podatkov SICRIS je potrebna avtorizacija, ki se izvaja pri vsakem klicu na osnovi pridobljenega žetona JWT. Veljavni žeton se pridobi na osnovi inicialnega klica REST z veljavnim uporabniškim imenom in geslom.

Žeton JWT se pridobi z izvedbo klica POST metode getjwt:

POST https://cris.cobiss.net/ecris/si/sl/service/getjwt

V telo klica POST za pridobitev žetona JWT je treba vključiti parametra username in password:

{

"username": "uporabniško_ime",

"password": "veljavno_geslo"

}

Rezultat zahteve ob uspešni avtorizaciji z veljavnim uporabniškim imenom in geslom v formatu JSON:

{

"jwt": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzeXN0ZW0iOiJzaSIsInNleCI6IkYiLCJzaWduZWRJbiI6dHJ1ZSwidXNySWQiOjQ1OTcsImVudGl0eUlkIjo0NzcwMiwidG9rZW5UeXBlIjoiU0hPUlQiLCJ0eXBlIjoiU0hPUlQiLCJ1c2VyTmFtZSI6IlJTUi5TSS40MDQ5MyIsImVudGl0eSI6IlJlc2VhcmNoZXIiLCJpc3MiOiJpenVtLnNpIiwiaWF0IjoxNjUyNzc1NTM2LCJleHAiOjE2NTI4NjE5MzZ9.Oh2ESevUmhHE0G1dGIzKNZZ6F4Nt2_2KZNfpSo5zaCI",

"statusKey": "Uspešno ste se prijavili",

"status": "OK"

}

V primeru nepravilnega klica ali napake so možni naslednji odzivi:

Status Pomen
401 Unauthorized Vnesena napačna evidenčna številka oz. e-naslov ali napačno geslo
404 Not found Podatki za podano iskalno zahtevo ne obstajajo
500 Internal_server_error Dostop do podatkov ni mogoč zaradi napačno navedenih parametrov klica
501 Not Extended V klicu REST manjka navedba metode

Pri klicih vseh nadaljnjih metod za dostop do podatkov entitet SICRIS je treba vključiti veljaven žeton JWT. Če žetona ni ali ni pravilen, strežnik vrne napako 401 (Unauthorized).

Veljavnost žetona JWT je 24 ur!

Klici za dostop do podatkov entitet SICRIS

Do podatkov, razpoložljivih v sistemu SICRIS, dostopamo s klici metod, ki se nanašajo na posamezne entitete sistema.

Entiteta SICRIS Klic REST
Raziskovalci

/researcher/search

/researcher/{id}

Projekti in programi

/project/search

/project/{id}

Organizacije

/organization/search

/organization/{id}

Skupine

/group/search

/group/{id}

Razpoložljive metode za dostop do podatkov posameznih entitet se uporabijo na enak način, kot je to prikazano na primeru klicev za dostop do podatkov o projektih in programih:

GET https://cris.cobiss.net/ecris/si/sl/service/project/search

Rezultat izvedenega klica GET:

{"frame":"MST","id":18090,"stat":"REG","statadm":"UPD","statdate":"2020-04-17T09:15:00","type":"PRG","classificationDescr":["Kmetijske rastline","Rastlinska produkcija in predelava","Biotehnika"],"counter":"5828","field":"03","science":"4","subfield":"01","avfte":4982,"code":"P4-0085","codeContract":"0085","codeProgramme":"P","codeScience":"4","enddate":"2025-12-31","firstName":"Domen","lastName":"Leštan","mstrank":"D","name":"Agroekosistemi","resaercherFullName":"dr. Domen Leštan","rsrCode":"08259","rsrid":6345,"rsrttl":"DOD","startdate":"2020-01-01","title":"dr.","uplimit":0}, ....

Primeri oblikovanja klica REST z vključevanjem parametrov in dostop do podatkov na osnovi ID Rezultat
... /project/search Osnovna poizvedba vrne prvih 10 zapisov s seznama projektov in programov
... /project/search?query=*&limit=ALL Vsi zapisi s seznama projektov in programov
... /project/search?query=matematika&limit=5 Prvih 5 zapisov s seznama projektov in programov
... /project/{id} (npr: ... /project/18090 Podatki o projektu s cerifId=18090
... /researcher/47702 Splošni podatki o raziskovalcu s SICRIS id=47702
... /researcher/search?query=35460 Širši nabor podatkov o raziskovalcu s šifro ARRS 35460 na osnovi izvedene iskalne poizvedbe.
... /researcher/search?query=&frascati=30000limit=20 Podatki o prvih 20 raziskovalcih s področja medicine
... /organization/search?query=AdriaData Podatki organizacij z imenom AdriaData
... /group/search?query=A-LIFE Podatki skupine z nazivom A-LIFE
... /project/search?query=L1&limit=5 Izpis podatkov o petih projektih s seznama projektov, vpisanih v sistem SICRIS, ki v delu evidenčne številke vsebujejo niz L1.
... /project/search?query=L1&offset=10&limit=5 Če želimo rezultate izpisovati po straneh, dodamo parameter offset. Pri rezultatu iz primera se v izpisu preskoči prvih 10 projektov in izpiše naslednjih 5.
Zgodovina ogledov
Priljubljeno