API

API er forkortelse for Application programming interface (applikasjonsprogrammerings- grensesnitt). Et API er et grensesnitt som gjør at flere programmer/datamaskiner kan kommunisere med hverandre. Reglene for hvilken  informasjon programmene får hente eller sende er definert i APIet.

Hvorfor bruke Cristins APIer?

Informasjon som registreres i Cristin gjøres tilgjengelig gjennom APIene. Informasjonen som hentes ut kan brukes til automatisk oppdatering av andre systemer, nettsider og registre. På samme måte kan Cristin hente informasjon fra andre systemer som har APIer.

Dette sparer brukerne fra å manuelt registrere samme informasjon flere steder. Det sikrer også at man har den samme informasjonen i de ulike systemene.

Gjenbruk av informasjon på nettsider

Cristins medlemsinstitusjoner kan hente ut informasjon om sine ansatte og deres resultater og prosjekter, og profilere denne på egne nettsider. Når en ny artikkel eller et nytt prosjekt blir registrert, eller det gjøres endringer i personprofilen i Cristin, vil nettsidene oppdateres automatisk. Dette sparer institusjonene fra å måtte holde oversikt med, og manuelt oppdatere, alle personprofilene på nettsidene.

Teknisk informasjon

Cristin har to ulike typer API i dag: WebService og REST API. APIene er nettbaserte, som innebærer at du ikke trenger å laste ned noe program for å ta dem i bruk. De bruker HTTPS (hypertext transfer protocol secure) for å utveksle informasjon:

  • GET (hent, søk)
  • POST (opprett, registrer)
  • PUT (sett inn, oppdater)

Svaret fra systemet leveres i to ulike formater: json (REST og Webservice) og XML (kun webservice).

Per i dag er det kun systemer vi har en kobling til som får opprette (POST) og oppdatere (PUT) informasjon i Cristin.

Krever teknisk kompetanse

Ta kontakt med lokal-it eller teknisk ansvarlige ved din institusjon for å få hjelp til å ta i bruk APIene.

Motta e-postvarsling for Cristins API-tjenester

Husk å melde dere på e-postlisten for API-tjenestene, der vi sender ut informasjon om endringer og nye versjoner

REST API

REST API er er nyutviklet API som er tilpasset den nye versjonen av Cristin-systemet. REST APIet er mer intuitivt, strukturert, utviklervennlig og robust. Det gjør det enklere å hente ut større mengder informasjon, i sanntid. WebService-tjenesten baserer seg på et "mellomlag" mellom database og grensesnitt, mens REST APIet henter data direkte fra databasen.

Teknisk beskrivelse av REST API

WebService

WebService-tjenesten er et eldre API som i dag brukes for å hente ut resultater knyttet til person. Tjenesten skal fases ut i løpet av de kommende 2 årene, og det blir ikke gjort endringer i eller forbedringer av dette APIet i løpet av denne perioden.

Vi anbefaler institusjoner som ikke bruker denne tjenesten i dag om å vente til det nye REST APIet for resultater er på plass.

Teknisk dokumentasjon for WebService-tjenesten