Versions Compared

Old Version 11

changes.mady.by.user babak.tavassoli

Saved on

compared with

New Version Current

changes.mady.by.user babak.tavassoli

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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

Dokumentasjonen til dette API’et 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.

  1. descriptions : Tekstlig beskrivelse av innholdet i ei bok.

  2. 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
simple0
zoom1
pageId2303131649
custContentId3415015449
diagramDisplayNameBibliotektjenester.drawio
lbox1
hiResPreview0
baseUrlhttps://

...

sikt.atlassian.net/wiki
diagramName

...

Bibliotektjenester.drawio
imgPageId2305720351
pCenter0
aspect

...

ORtwjUOShnAaPGsRGF9l 1

...

includedDiagram

...

1

...

width

...

1626
aspectHash

...

8a7dcec203c98c3767dc883ee3e52ca2da27ae5f
linksauto
tbstyletop
height

...

1115

Nøkkel info

Initiering av flyt

Scheduler (

fire ganger hver dag

1 runde for hvert “objects” og “description”)

 

Flyt mønster

Synkron

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

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

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

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-ext

Sender contents, isbn (ISBN13), description_long, audio_file, image_small, image_large, image_original og source til API mot Alma

legget

laget av Team Smile

putInfo

 Bokbasen Extension

Denne metoden brukes for å hente objekter fra Bokbasen database. Den mottar enten en "siden"-verdi (since brukes bare hvis next ikke er angitt) eller en "neste"-verdi (next). Resultatet fra databasen transformeres fra xml til json (den setter pagesize hvis spesifisert, ellers brukes bokbasens standard).

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 (since brukes bare hvis next ikke er angitt) eller en "neste" verdi (next). Resultatet fra databasen transformeres fra xml til json.

getPagedDescriptionsSince

Tilgangsstyring og logging

  • Integrasjonen loger til Humio med detaljert logging av prosessen.

  • Tilgangstyringen (autentisering via API-keys) skjer via Gravitee. Authorisasjonen håndteres via Auth-modulen vår.

...

  • 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. 2s (avhengig av antall objekter/beskrivelser)

  • Frekvens: Scheduler (: 1 runde hver dag, med fire ganger hver dag for hvert “object” og “description”) for datastrømmestrategi. 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: ): ca. 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.

  • 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.

    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.