"API" er ei forkorting for Application programming interface (applikasjons-programmerings-grensesnitt). Eit API er eit grensesnitt som gjer at fleire program/datamaskiner kan kommunisere med kvarandre. Reglane for kva informasjon programma får hente eller sende er definert i API-tenesten.
Kvifor bruke Cristins API-tenester?
APIa gjer at informasjon som vert registrert i Cristin kan hentast ut for å oppdatere andre system, nettsider og register. På same måte kan Cristin bruke APIa for å hente informasjon frå andre system som har API-tenester.
Når fleire system utvekslar informasjon automatisk, vert brukarane spara frå å manuelt registrere same informasjon i dei ulike systema.
Gjenbruk av informasjon på nettsider
Cristins medlemsinstitusjonar kan hente ut informasjon om sine tilsette og deira resultat og prosjekt, og profilere det på eigne nettsider. Når ein ny artikkel eller eit nytt prosjekt vert registrert, eller det vert gjort endringar i personprofilen i Cristin, vert nettsidene automatisk oppdatert. Dette sparar institusjonane frå å manuelt holde oversyn på og oppdatere informasjonen.
Teknisk informasjon
Cristin har i dag to ulike typar API: Webservice og REST API. APIa er nettbaserte, som inneber at du ikkje treng å laste ned noko program for å ta dei i bruk. Dei brukar HTTPS (hypertext transfer protocol secure) for å utveksle informasjon:
- GET (hent, søk)
- POST (opprett, registrer)
- PUT (sett inn, oppdater)
Informasjon frå Cristin-systemet vert utlevert i to ulike format: json (REST og Webservice) og XML (kun Webservice).
I dag er det kun system vi har ei kopling til som får opprette (POST) og oppdatere (PUT) informasjon i Cristin.
Krever teknisk kompetanse
Ta kontakt med lokal-it eller dei teknisk ansvarlege ved din institusjon for å få hjelp til å ta i bruk API-tenestene.
Motta e-postvarsling for Cristins API-tenester
Er du superbrukar eller teknisk tilsett ved ein institusjon som brukar ei av våre API-tenester, hugs å melde deg på e-postlista for API-tenestene. Der sender vi ut informasjon om endringar og nye versjonar.
REST API
REST APIet er eit nyutvikla API som er tilpassa den nye versjonen av Cristin-systemet. REST API er meir intuitivt, strukturert og robust. Det gjer det enklare og raskare å hente ut større mengder informasjon. Webservice-tenesten baserer seg på eit "mellomlag" mellom database og grensesnitt, mens REST API henter data direkte frå databasen.
Webservice
Webservice-tenesten er eit eldre API som i dag vert brukt for å hente ut resultat som er knytta til ein person. Tenesten vert fasa ut i løpet av dei neste 2 åra, og det vert ikkje gjort endringar i eller forbetringar av Webservice-tenesten i denne perioden.
Vi tilråder institusjonar som ikkje brukar denne tenesten i dag om å vente til det nye REST APIet for resultat er på plass.
