Innledning
Dette er et proxy-api som i hovedsak gjenspeiler DigEks API’et fra FS. https://www.fellesstudentsystem.no/brukersider/teknisk/fsws-dok/rest/digitaleksamen.html#digeks_liste
Dokumentasjonen til dette API’et er å finne her : https://api-sikt.intark.uh-it.no/catalog/api/81ecdc41-73ed-48c4-acdc-4173ed88c4e9?q=digex
Hoved funksjonen er er at den bygger en Authentiisering og authorisasjonslag på toppen av den eksisterende API’et fra FS. Brukeren av dette API’et er eksamensystemer.
Nøkkel info
Initiering av flyt | Scheduler (fire ganger hver dag for hvert “objects” og “description”) |
|
---|---|---|
|
|
|
Bruk av meldingskø | Nei |
|
|
|
|
|
|
|
Bakgrunn
Da FS DigEks i sin tid ble opprettet, hadde den ikke noe passende mekanisme for tilgangskontroll. Den var heller ikke egnet for å stå som en ekstern endepunkt mot et ukjent antall eksamen-systemer. Et API ble derfor opprettet via Mule som samtidig sørget for et mer uniformt API.
Interessenter
Brukeren av API’et er eksamensystemer som trenger data fra FS.
Brukerhistorie
Eksamensystem X skal kunne utføre disse operasjonene:Hent liste av eksamenerHent info for en eksamenRegistrere sensur for en eksamenTestregistrere sensur for en eksamenRegistrere oppmøte for en eksamenHent begrunnelser for eksamenRegistrere begrunnelse gitt til en kandidat for en eksamenHent klager for eksamenRegistrere et vedtak for klagesensur (Registrere et vedtak for eksamen)Registrere gruppeid for kandidaterHent eksamener filtrert på hjelpemiddelHent klager endret siden tidspunktHent begrunnelsesforespørsler endret siden tidspunkt
Systemer/tjenester
Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?
System | Data | Brukt API (endepunkter) |
---|---|---|
Config-databasen | Finner | configDB.orgs (fsIdToOrgShortName) |
Config-databasen | Finner dokument i databasen til en | configDB.orgs (getSingleOrg) |
Auth | Autentiserer brukeren med | authenticateWithApikey (gravitee) |
Auth | Autentiserer brukeren med | authenticate |
Auth | Autentiserer brukeren med | autheiticate directly with apikey |
LaaS | Registrerer en indeks | do Index |
FS (gjennom DigEks API’et) | For detaljer om data sent/mottatt se dokumentasjon til API’et https://api-sikt.intark.uh-it.no/catalog/api/81ecdc41-73ed-48c4-acdc-4173ed88c4e9?q=digex
| /eksamen/liste /eksamen/<system>/<ID> /eksamen/sensur/<system>/registrer /eksamen/sensur/<system>/valider /eksamen/oppmote/<system>/registrer /eksamen/begrunnelser/<SYSTEM>/<ID> /eksamen/begrunnelser/<SYSTEM> /eksamen/klager/<SYSTEM>/<ID> /eksamen/vedtak/<SYSTEM> /eksamen/gruppeid/<SYSTEM>/registrer /eksamen/hjelpemiddel /eksamen/klager/<SYSTEM> /eksamen/begrunnelse/<SYSTEM>
|
|
|
|
Tilgangsstyring og logging
Integrasjonen loger til Humio med detaljert logging av prosessen.Integrasjonen er knyttet logg-oversikten som vil logge følgende data:
errorMessage (tekst)
host
httpStatus
institusjonsId
method
orgId
orginal_user
remote_address
request_uri_inn
success (boolsk)
tjeneste
user
vurdId (examID)
Tilgangstyringen (autentisering via API-keys) skjer via Gravitee. Authorisasjonen håndteres via Auth-modulen vår.
Forretningsregler
Behandlingstid/responstid og volum
Behandlingstid/responstid: ca. 1ms
Frekvens: HTTPS-‘listener’ repeterbar fillagerstrøm for datastrømmestrategi
Volum (målt: ): gj.sn. ca. 66k hits daglig
Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse
Hva skjer ved overload i kø?Det finnes ikke noe kø her, men en overload av kall fra eksamensystemer er mulig og vil føre til feilede kall.
Hva skjer med ufullstendige meldinger?Det finnes ikke noe meldinger, men ufullstendige eller invalide kall vil føre til feilmeldinger. Enten fra Mule eller fra FS-API’et.
Inneholder meldingene personopplysninger?Ja i form av navn, e-postadresse eller brukernavn.
Noe om viktige feil/situasjoner som må passes ekstra på (som kan ha stor konsekvens) :Det mest sannsynlige er at tjenesten faller bort. Dette kan skje ved flere nivåer. Enten Gravitee i front, Mule tjenesten selv eller feil i FS. En slik utfall kan i verste fall ødelegge for eksamengjennomføring. Ingen av kallene/operasjonene i dette API'et er nødvendig for selve gjennomføringen av eksamen, men for oppsett. Det er alltid noen “last-minute” endringer som vil bli rammet om denne integrasjonen ikke fungerer.Feil i data levert fra FS kan rote til opprettelse av prøver i eksamensystemene.Da dette API’et brukes også til å sette sensur, feil som f.eks. sette på feil karakter til en student, vil ha store omdømme konsekvenser.