Julkaisukanavatietokannan REST-rajapinta
REST rajapinan avulla voit integroida Tieteellisen seurain valtuuskunnan ylläpitämän julkaisukanavatietokannan osaksi omia tietojärjestelmiäsi. Rajapinta on julkinen. Voit etsiä yksittäisiä julkaisukanavia issn-, 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.
Rajapinnan toiminnallisuus:
ETSI
Etsi sovelluksella voit etsiä julkaisukanavia, eri hakukriteereitä käyttäen. Sovelluksen kutsuosoite on seuraava:
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 Tunniste numerokoodina. esim. 978-963-46. Julkaisukanavatietokannassa on vain ISBN tunnisteen juuriosa eli kustantajan tunniste. |
| issn | ISSN tunniste | 0-9- | 10 | Julkaisukanavan ISSN tunniste |
| tyyppi | Julkaisukanavan tyyppi | 1-3 | 1 | 1=Lehti/Sarja 2=Kirjakustantaja, 3=Konferenssi. Rajaava hakutekijä. |
Rajapinta palauttaa seuraavat tiedot:
| kenttä | kuavus | tyyppi | huomioita |
|---|---|---|---|
| JUFO_ID | Julkaisukananavan ID tunniste | int(11) | Julkaisukanavan yksilöivä tunniste |
| Link | URL Julkaisukanavan tietoihin | varchar(50) | esimerkiksi: https://kanava-dev.csc.fi/jufo/kanava/64592 |
| Name | Julkaisukanavan nimi | varchar(255) | |
| Type | Julkaisukanavan tyyppi | varchar(45) | Lehti/Sarja, Kirjakustantaja tai konferenssi |
Esimerkki hakuja
Haetaan Julkaisukanava tietoja nimen perusteella.
https://kanava-dev.csc.fi/jufo/etsi.php?nimi=Oxford
Haetaan Julkaisukanavatietokannasta kirjakustantajia nimen perusteella
https://kanava-dev.csc.fi/jufo/etsi.php?nimi=Oxford&tyyppi=2
Haku ISBN numeron perusteella:
https://kanava-dev.csc.fi/jufo/etsi.php?isbn=978-87-7496&tyyppi=2