API-katalog for studieadministrasjon
Sikt tilbyr følgende APIer for studieadministrative prosesser:
| Navn | Teknisk dokumentasjon | Status |
|---|---|---|
| FS GraphQL | Teknisk dokumentasjon for FS GraphQL API | Produksjon |
| Gemini | OpenAPI-dokumentasjon for Gemini | Produksjon |
| Gammelt FS-API | Teknisk dokumentasjon for FS-APIet | Videreutvikles ikke |
| FSWS-BAS (REST) | Teknisk dokumentasjon for FSWS-BAS (REST) | Videreutvikles ikke |
| FSWS-BAS (SOAP) | Teknisk dokumentasjon for FSWS-BAS (SOAP) | Avvikles etter 31. mars 2025 |
| FSWS-CRUD (REST) | Teknisk dokumentasjon for FSWS-CRUD (REST) | Videreutvikles ikke |
| FSWS-BRIS (REST) | Teknisk dokumentasjon for FSWS-BRIS (REST) | Videreutvikles ikke |
| FSWS-STUDRAPP (REST) | Teknisk dokumentasjon for FSWS-STUDRAPP (REST) | Videreutvikles ikke |
| FSWS-STUDINFO2 (REST) | Teknisk dokumentasjon for FSWS-STUDINFO2 (REST) | Videreutvikles ikke |
Hvordan får jeg tilgang?
Du må ha en API-bruker for å få tilgang til APIene i denne katalogen. Alle dataene som i dag blir tilgjengeliggjort via disse APIene, eies av FS-institusjoner, så for å få tilgang, må du kontakte den enkelte FS-institusjonen. I noen tilfeller vil institusjonen kunne delegere tilgang til deg direkte. Dersom bruker eller tilganger må settes opp av Sikt, kan institusjonens FS-kontakt bestille dette vi nettskjema på www.fellesstudenstystem.no.
Vi forutsetter at nødvendige databehandleravtaler er inngått før tilgangen blir bestilt.
Versjonering
API-katalogen er nå på hovedversjon 2
API-katalogen kommer med ny hovedversjon én gang i året. Ny hovedversjon legges ut i vårhalvåret, og ikke tidligere enn 31. mars.
API-kontrakter
Alle APIer i denne katalogen, skal ha en eksplisitt status som definerer hvilken kontrakt som gjelder for APIet som helhet. Merk at enkelte deler av et API kan ha en kontrakt som avviker fra det som er angitt på toppnivå. Det skal i så fall være tydelig markert i maskinlesbar dokumentasjon eller annen teknisk dokumentasjon hvilke deler av APIet som er underlagt hvilken kontrakt. Når du tar i bruk ett av APIene i katalogen, aksepterer du API-kontrakten. Sikts forpliktelser i henhold til kontrakten er som følger:
Kontrakt for APIer i produksjon
Følgende gjelder for APIer eller deler av APIer med status "Produksjon" og "Videreutvikles ikke".
- Sikt forplikter seg til å levere all funksjonalitet som er beskrevet i maskinlesbar API-dokumentasjon og/eller tilsvarende teknisk dokumentasjon til og med neste hovedversjon av API-katalogen.
- Ikke-bakoverkompatible endringer kan kun gjøres i forbindelse med produksjonssetting av ny hovedversjon av API-katalogen.
- Bakoverkompatible endringer spesifiseres og bygges fortløpende. De lanseres så fort de er ferdige.
- Ikke-bakoverkompatible endringer kan kun gjøres dersom de ble varslet før produksjonssetting av forrige hovedversjon av API-katalogen.
- Ikke-bakoverkompatible endringer kan varsles når som helst i løpet av en hovedversjon.
Kontrakt for APIer i beta
Følgende gjelder for APIer eller deler av APIer med status "Beta":
- Sikt forplikter seg til å levere maskinlesbar API-dokumentasjon og/eller tilsvarende teknisk dokumentasjon for all funksjonalitet i APIet.
- APIet kan inneholde kjente og ukjente feil
- Alle endringer spesifiseres og bygges fortløpende. De lanseres så fort de er ferdige.
- Ikke-bakoverkompatible endringer skal varsles minimum 2 uker før produksjonssetting.
Kontrakt for APIer med status "Eksperimentelt"
Følgende gjelder for APIer eller deler av APIer med status "Eksperimentelt":
- Det kan eksistere maskinlesbar API-dokumentasjon og/eller tilsvarende teknisk dokumentasjon for hele eller deler av APIet
- APIet kan inneholde kjente og ukjente feil
- Alle endringer spesifiseres og bygges fortløpende. De lanseres så fort de er ferdige.
- Ikke-bakoverkompatible endringer kan produksjonssettes uten forvarsel.
Slik går du fram for å få løftet et API eller deler av et API til beta eller produksjon
- Ny funksjonalitet blir normalt lagt ut i test- og produksjonsmiljøene på eksperimentell kontrakt. I denne fasen kan du utforske funksjonaliteten og vurdere om du ønsker å ta den i bruk.
- Når du er ferdig med utforskingen, kan du be om at funksjonaliteten gjøres tilgjengelig på beta-kontrakt. For å sørge for at APIet løser behovene dine, bør du også gjøre rede for hvilket behov APIet skal løse for deg, og hvordan du ønsker å bruke det. Vi vil da vurdere om funksjonaliteten er klar for å tilgjengeliggjøres i beta etter gjeldende kriterier, og eventuelt gjøre nødvendige endringer. I beta-test-perioden kan vi gjøre endringer i APIet i samarbeid med deg. Merk at beta-testing normalt skal skje i samarbeid med en FS-institusjon.
- Når du er fornøyd med beta-testen, kan du be om at funksjonaliteten løftes opp i full produksjon. Vi vil da vurdere om funksjonaliteten er klar til produksjonssetting etter gjeldende kriteringer, og eventuelt gjøre nødvendige endringer.
- Vi endrer kontrakten for funksjonaliteten til full produksjon.
Varsling
Versjonsendringer og driftsrelaterte meldinger relatert til API-katalogen vil bli varslet på en egen e-postliste. Send e-post til fs-plattform-brukere-join@lister.sikt.no dersom du ønsker å motta disse varslene.