Julkaisukanavatietokannan REST-rajapinta
REST-rajapinnan avulla voit integroida Julkaisufoorumin julkaisukanavatietokannan osaksi omia tietojärjestelmiäsi. Rajapinta on julkinen. Voit etsiä yksittäisiä julkaisukanavia ISSN-tunnisteen, ISBN-tunnisteen tai nimen perusteella tai hakea koko julkaisukanavan tietosisällön kerralla. Rajapinta palauttaa julkaisukanavatietokannan sisällön JSON-formaatissa, josta alla tarkemmat kuvaukset. Rajapinta tukee W3C Cross-Origin Resource Sharing (CORS) -toiminnallisuutta.
Esimerkkitoteutus (html/javascript) löytyy osoitteesta: https://jufo-rest.csc.fi/demo/demo.html
Rajapinnan toiminnallisuuksia:
ETSI
ETSI-sovelluksella voit etsiä julkaisukanavia eri hakukriteereitä käyttäen. Sovelluksen kutsuosoite https://jufo-rest.csc.fi/v1.0/etsi.php
Parametrit:
| parametrin nimi | kuvaus | sallitut merkit | pituus(max) | huomioita |
|---|---|---|---|---|
| nimi | Julkaisukanavan nimi | a-Z0-9 | 50 | Voit hakea julkaisukanavaa nimellä tai sen osalla |
| isbn | ISBN tunniste (juuri) | 0-9- | 20 | ISBN-tunnisteen juuri numerokoodina, esim. 978-963-46. Julkaisukanavatietokannassa on vain ISBN-tunnisteen juuriosa eli kustantajan tunniste. |
| issn | ISSN tunniste | 0-9- | 10 | Julkaisukanavan ISSN-tunniste |
| lyhenne | Konferenssin lyhenne | a-Z0-9 | 20 | Konferenssin vakiintunut lyhenne |
| tyyppi | Julkaisukanavan tyyppi | 1-3 | 1 | 1=Lehti/Sarja 2=Kirjakustantaja, 3=Konferenssi. Rajaava hakutekijä. |
Rajapinta palauttaa seuraavat tiedot:
| kenttä | kuvaus | tyyppi | huomioita |
|---|---|---|---|
| JUFO_ID | Julkaisukananavan JUFO-ID-tunniste | int(11) | Julkaisukanavan yksilöivä tunniste |
| Link | URL julkaisukanavan tietoihin | varchar(50) | esimerkiksi: https://jufo-rest.csc.fi/v1.0/kanava/64592 |
| Name | Julkaisukanavan nimi | varchar(255) | |
| Type | Julkaisukanavan tyyppi | varchar(45) | Lehti/Sarja, Kirjakustantaja tai konferenssi |
Esimerkki hakuja
Haetaan julkaisukanavan tietoja nimen perusteella.
https://jufo-rest.csc.fi/v1.0/etsi.php?nimi=Oxford
Haetaan Julkaisukanavatietokannasta kirjakustantajia nimen perusteella
https://jufo-rest.csc.fi/v1.0/etsi.php?nimi=Oxford&tyyppi=2
Haku ISBN-tunnisteen perusteella:
https://jufo-rest.csc.fi/v1.0/etsi.php?isbn=978-87-7496&tyyppi=2
Yksittäisen julkaisukanavan hakeminen
Toiminnallisuudella voidaan hakea yksittäisen julkaisukanavan tiedot. Toiminnallisuus löytyy osoitteessa.https://jufo-rest.csc.fi/v1.0/kanava/
Parametrit:
| parametrin nimi | kuvaus | sallitut merkit | pituus(max) | huomioita |
|---|---|---|---|---|
| /Jufo_ID | Julkaisukanavan JUFO-ID-tunniste | 0-9 | 11 |
Kutsu palauttaa seuraavat tiedot
| Kenttä | tyyppi | kuvaus |
|---|---|---|
| Jufo_ID | int(11) | Unique channel identifier |
| Level | int(4) | Current level |
| Name | varchar(255) | Name |
| Abbreviation | varchar(100) | Conference abbreviation |
| Other_Title | varchar(255) | Other language title or form |
| Title_Details | varchar(255) | Comments on the title |
| ISSNL | varchar(45) | ISSNL |
| ISSN1 | varchar(45) | ISSN-print |
| ISSN2 | varchar(45) | ISSN-online |
| ISBN | varchar(200) | ISBN-codes |
| Continues | varchar(255) | Jufo_ID of the predecessor |
| Continued_by | varchar(255) | Jufo_ID of the successor |
| Type | varchar(45) | Journal/series, Conference, or Book publisher |
| Website | varchar(1000) | WWW-link |
| Country | varchar(45) | Publishing country |
| Publisher | varchar(170) | Publisher (and society) |
| Language | varchar(200) | Publishing languages |
| Year_Start | int(11) | Start year |
| Year_End | int(11) | End year |
| Active | varchar(45) | Active if no end year, Inactive if end year |
| Norway_Level | int(4) | |
| Denmark_Level | int(4) | |
| SJR_SJR | decimal(6,3) | |
| SNIP | varchar(45) | |
| IPP | varchar(45) | |
| DOAJ_Index | int(11) | 1 indicates channels indexed in DOAJ |
| Sherpa_Romeo_Code | varchar(45) | Green, Blue, Yellow, White |
| CreatedAt | datetime | Date of creation of Jufo_ID (2012-12-12 12:12:12) |
| ModifiedAt | datetime | Date of latest modification Jufo_ID (2012-12-12 12:12:12) |
| Active_Binary | int(1) | 1 indicates included, 0 excluded channels (e.g. duplicates) |
| Predator | int(1) | 1 indicates channels included in Beall's list |
| Jufo_2012 | int(4) | 2012 level |
| Jufo_2013 | int(4) | 2013 level |
| Jufo_2014 | int(4) | 2014 level |
| Jufo_2015 | int(4) | 2015 level |
| Fields | varchar(100) | Codes for ERIH, Norwegian, Danish, WOS, Sopus, and MinEdu -fields |
| Scientific | int(1) | 1 Indicates scientific publications channel |
| Professional | int(1) | 1 indicates professional publication channel |
| General | int(1) | 1 indicates genera public publication channel |
Esimerkkihakuja:
https://jufo-rest.csc.fi/v1.0/kanava/64592
Koko julkaisukanavatietokannan sisällön hakeminen
Koko julkaisukanavatietokannan sisällön voi hakea JSON-muodossa osoitteesta https://jufo-rest.csc.fi/v1.0/massa.json.zip
Massa,json tiedoston päivitetään kerran yössä.
Poikkeustilanteet
Jos julkaisukanavaa ei löydy rajapinta palauttaa tyhjän JSON-tiedoston vastauksena. Mikäli parametrien käsittelyssä on virhe (väärä parametri), palauttaa rajapinta http status -koodin 400 "Bad Request".