Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

HTTPS Listener svarer på en HTTPS-URL (/v1/*, /vt1/* eller /console/*) for å initiere flytene i appen.

 

Flyt mønster

Synkron

Tar imot HTTP forespørsler fra eksamen-systemer og videresender dem til FS DigEks

Bruk av meldingskø

Nei

 

Open API

Nei

Men brukes av eksterne systemer

IntArk

JA

Bruker Gravitee. Mule-endepunktet ligger bak Gravitee.

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 eksamener

    • Hent info for en eksamen

    • Registrere sensur for en eksamen

    • Testregistrere sensur for en eksamen

    • Registrere oppmøte for en eksamen

    • Hent begrunnelser for eksamen

    • Registrere begrunnelse gitt til en kandidat for en eksamen

    • Hent klager for eksamen

    • Registrere et vedtak for klagesensur (Registrere et vedtak for eksamen)

    • Registrere gruppeid for kandidater

    • Hent eksamener filtrert på hjelpemiddel

    • Hent klager endret siden tidspunkt

    • Hent 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 orgShortName (ShortName) i databasen til en gitt institutionID (FsId)

configDB.orgs (fsIdToOrgShortName)

Config-databasen

Finner dokument i databasen til en orgShortName (ShortName) med institutionID (FsId)

configDB.orgs (getSingleOrg)

Auth

Autentiserer brukeren med username, password og apiKey (kilde fra MongoDatabase)

authenticateWithApikey (gravitee)

Auth

Autentiserer brukeren med system ("digex"), username og password (dpClientId og dpGatekeeper er valgfrie). Kilde fra MongoDatabase.

authenticate

Auth

Autentiserer brukeren med API key og password, hvis username er "direkteAPIKEY"

autheiticate directly with apikey

LaaS

Registrerer en indeks org, instance, env, event-name, remote-adr og request-uri i Humio (for å innta og beholde strømmedata)

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.

  • No labels