Innhente data - løsningsmønster UHF

En prosessflyt en konsument utfører når det utføres et tjenestekall for å innhente data gjennom et API. API-adressen hentes i API-katalogen. Tilgang til APIet byttes inn mot et kjøretids-token i autoriseringstjenesten. Tjenestekall til APIet utføres gjennom API gateway der tokenet benyttes for å få tilgang. Dersom det er et åpent API er det kun relevante prossessteg som utføres.

Innhente data - løsningsmønster UHF image
Figure 1. Innhente data - løsningsmønster UHF
Gå tilbake til standardvisning ved å klikke 'tilbake' (eller lukk dette vinduet om det er nytt)
Table 1. Elementer i view for Innhente data - løsningsmønster UHF
Element Beskrivelse

UHF Infrastruktur

Samtykkeregistrerings-tjeneste

Tjeneste for å innhente samtykke fra den registrert som dataene gjelder. Dette kan være en person eller en virksomhet.

Adressetjeneste

Tjeneste som gir mulighet til å slå opp teknisk endepunkt

Virksomhetssertifikat

En virksomhets elektroniske ID. Benyttes for å autentisere virksomheten overfor tokentjenesten.

Tokentjeneste

Tjeneste som utsteder sikkerhetsbilletter. Sikkerhetsbillett utstedes basert på tildelte rettigheter og eventuelle representasjonsforhold.

Oppslag representasjons-forhold

Tjeneste som benyttes av tokentjenesten for å kontrollere om det foreligger et delegert representasjonsforhold fra konsument til leverandør i autorisasjonstjenesten til Altinn.

Tilganger konsument

Oversikt over hvilke API og OAUTH-scopes en virksomhet (representert ved organisasjonsnummer) skal ha tilgang til (utstedt token for).

UHF Autorisasjonstjener

Autorisasjonstjenester realiserer tilgangskontroll gjennom å utstede sikkerhetsbilletter. En autorisasjonstjener er også brukt til å realisere autorisasjonspolicy for tilgang og roller.

UHF API katalog

Oversikt over alle API som er registrert i UH/F sektoren

UH/F API katalog kan inneholde

  • Navn på API

  • Tekstlig beskrivelse av API

  • Informasjonsmodell / Datamodell for API som tilbys

  • Kildeinformasjon for data, begrepsinformasjon

  • Eksempelkode, interaktiv API-konsoll og sandkasse for test

  • Informasjon om hvordan få support og hjelp fra utsteder

  • Informasjon om tilgang, juridiske og tekniske begrensinger for bruk. Inkluderer hvilke rettigheter (OAuth2 scopes) en konsument kan få til et API.

  • Grensesnitt for å presentere APIer

  • Grensesnitt for å søke etter APIer

Endepunkt (adresse)

Dataobjekt som representerer teknisk adresse til et API eller ressurs.

Gi konsument adgang til data

Tjeneste for å gi datakonsument adgang til data. Tjenesten kan realiseres gjennom utveksling av data over aktuell transportprotokoll, f.eks, gjennom asynkrone meldinger eller synkrone API-oppslag. Tjenesten kan også realiseres ved å gi konsumenten adgang til data er de ligger, f.eks, innen forskning for analyse av store datamengder.

Nasjonal Infrastruktur

Maskinporten

Maskinporten sørger for sikker autentisering og tilgangskontroll for datautveksling mellom virksomheter, maskin til maskin. Dette gir teknisk og organisatorisk samhandlingsevne.

Datakonsument

Den som innhenter eller mottar data fra andre aktører.

Aksessere data

Evnen til å aksessere data fra en annen aktør. Evnen kan realiseres enten som utveksling av data, eller gjennom å kunne aksessere data der det ligger.

Slå opp data gjennom et API

Prosessen med å slå opp og hente data gjennom et API.

Hent teknisk endepunkt ved behov

Prosessen å slå opp den tekniske adressen til et API før datatilgang gjennom API-et. Gjøres kun dersom det er nødvendig.

Be om tilgangstoken

Prosessen med å benytte en sikkerhetsbillettjeneste for å hente en sikkerhetsbillett som gir tilgang til et API. Dette forutsetter at alt er registrert og satt opp riktig mot de aktuelle tjenestene.

Utfør tjenestekall for innhenting av data

Prosessen med å benytte (gjøre et oppslag mot) et eksternt API.

Innhent samtykke ved behov

Prosess for å innhente samtykke fra person eller virksomhet som grunnlag for å innhente eller oppdatere data. Dette gjøres kun ved behov.

Felles API-katalog

Del av Felles datakatalog som gir mulighet for å søke etter API-er og lese API-spesifikasjoner https://fellesdatakatalog.brreg.no/apis

Altinn autorisasjon

Autorisasjonskomponenten i Altinn som gir muligheter til å delegere rettigheter til andre organisasjoner eller personer. Rettigheter til bruk av autorisasjonskomponenten baserer seg på registrerte roller i Enhetsregisteret. Altinn autorisasjon leverer også tjenester for å registrere og kontrollere samtykke gitt av person eller virksomhet.

Altinn autorisasjon gir teknisk samhandlingsevne ved at bruker logger inn med elektronisk ID, autorisasjonskomponenten sjekker at bruker har de tilgangene som kreves for å ta i bruk aktuell tjeneste.

Dersom en privatperson skal ta i bruk en tjeneste på vegne av en virksomhet, gjøres det et oppslag mot Enhetsregisteret for å bekrefte at personen har en rolle på vegne av virksomheten. Dette gir organisatorisk samhandlingsevne.

Gå tilbake til standardvisning ved å klikke 'tilbake' (eller lukk dette vinduet om det er nytt)