Table of Contents |
---|
...
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
...
Table of Contents |
---|
...
Innledning
Denne i integrasjonen, er en del av “innholdsinformasjon-integrasjonen”. Denne sørger for å hente ut bok-data om norske utgivelser og sende dem til en intern API/forsystem til Alma, bibliotek-systemet.
Det overføres 2 type informasjon.
descriptions : Tekstlig beskrivelse av innholdet i ei bok.
objects : Dette består av eventuelle bilder eller lyd-objekter om en enkel bok.
Dokumentasjonen om bokdatabasen er å finne her : https://api-siktbokbasen.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.
jira.com/wiki/spaces/api/pages/119572243/API+for+Digital+Lending+Platforms
Inc drawio | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Nøkkel info
Initiering av flyt |
---|
Scheduler (1 runde for hvert “objects” og “description”) |
|
Flyt mønster | Synkron |
---|
Henter listen over objects og descriptions og sender dem en og en til det interne API’et i AWS laget av team-smile | ||
Bruk av meldingskø | Nei |
|
---|---|---|
Open API | Nei |
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 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
Nei |
Bakgrunn
Bibliotek-systemet trenger å bli oppdatert med info om nye bøker og eller oppdatering av info på eksisterende. Dette skjer via eksterne tjenester, i dette tilfellet, bokbasen.
Brukerhistorie
Beskrivelse eller bilde/lyd info om nye bøker skal automatisk hentes og oppdatere innholdet i bibliotek-systemet.
Oppdaterte beskrivelse eller bilde/lyd info om eksisterende bøker skal automatisk hentes og oppdatere innholdet i bibliotek-systemet.
Systemer/tjenester
Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?
System | Data | Brukt API (endepunkter) |
---|
Innholdsinformasjon- |
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
Code Block |
---|
/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>
|
ext | Sender | putInfo |
Bokbasen Extension | Denne metoden brukes for å hente objekter fra Bokbasen database. Den mottar enten en "siden"-verdi ( Objektrapporten (bilder og lydfiler) inneholder identifikatorer og referanser til adressen hvor objektene kan lastes ned. Disse referansene vil være gyldige i en begrenset periode. | getPagedObjectsSince https://bokbasen.jira.com/wiki/spaces/api/pages/67993638/Objects |
Bokbasen Extension | Denne metoden brukes for å hente beskrivelser fra Bokbasen database. Den mottar enten en “siden”-verdi ( | getPagedDescriptionsSince |
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
Ingen tilgangstyring er nødvendig.
Forretningsregler
Hver natt hentes en liste over alle nye beskrivelser og objekter. For hver beskrivelse/object kalles API-endepunktet som oppdaterer informasjonen i bibliotek-systemet.
Behandlingstid/responstid og volum
Behandlingstid/responstid: gj. snitt ca. 1ms2s (avhengig av antall objekter/beskrivelser)
Frekvens: HTTPS-‘listener’ repeterbar fillagerstrøm for datastrømmestrategi: Scheduler : 1 runde hver dag, med fire ganger for hvert “object” og “description”. Hver runde består av flere kall, da det er en grense på ca 1000. Det vil si hvis en dag det er flere enn 4000 oppdateringer, blir de ikke alle med den dagen.
Volum (målt: 27 Jul ): gj.sn. ca. 66k hits 1000 “descriptions” og 300 “objects” 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.
Det finnes ikke noe meldinger, men ufullstendige eller invalide kall vil føre til feilmeldinger. Enten fra Mule eller fra FS-API’etHva skjer med ufullstendige meldinger?Ved feil i post til AWS-tjenesten eller feil i data-format mottatt fra bokbasen.
Feil logges i humio.
Inneholder meldingene personopplysninger?
Ja i form av navn, e-postadresse eller brukernavnNei, ingen personopplysninger er involvert.
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 konsekvenserFeil bok oppdateres med info om en annen bok
Vi går glipp av oppdateringer.