Få tilgang til data - løsningsmønster UHF

En prosessflyt en konsument av data må gjennomføre for å få tildelt rettigheter til data gjennom et API. Det omfatter å få kjennskap til aktuelt API gjennom API-katalogen, autentisere konsumenten, inngå avtale om bruk av data, samt å registrere tilganger hos den tekniske komponenten som skal utføre tjenestekallet. Dersom det dreier seg om tilgang til et åpent tilgjengelig API, kan enkelte delaktiviteter i prosessene hoppes over, men for å kunne logge informasjon om bruk av APIer bør alle konsumenter av et API registreres i klientregisteret.

Viewet bør strengt tatt vise at konsumenten kan finne APIet enten i UHF sektorens API katalog eller i Felles datakatalog. Vi velger å vise prosessflyten kun med UHF sektorens komponenter både for å kunne presentere en oversiktlig prosessflyt og fordi forholdet til de nasjonale felleskomponenter ennå ikke er helt avklart.

Få tilgang til data - løsningsmønster UHF image
Figure 1. Få tilgang til 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 Få tilgang til data - løsningsmønster UHF
Element Beskrivelse

Datakonsument

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

Få tilgang til API

Prosessen med å skaffe seg tilgang til tilbudte data fra annen aktør. Omfatte å finne API-er, inngå nødvendige avtaler og få tilganger.

Inngå avtale om tilgang til data

Prosess for å inngå avtale om tilgang og bruk av data.

Registrer klient med tildelt tilgang

Prosess for konsument å registrere (provisjonering av) den klienten som skal ha tilgang til API-et ved bruk av sikkerhetsbillett. Dette forutsetter at konsumenten har avtale om bruk av sikkerhetsbillettjenesten og at tilbyder har gitt konsumenten tilgang.

Dersom det er en leverandør som har blitt delegert rettigheter som databehandler på vegne av konsument er det leverandøren som registrer sin klient.

Finn/få kjennskap til API

Prosessen med å finne eller få kjennskap til tilgjengelige API-er gjennom relevante kataloger og søkeløsninger.

Autentisere konsument

Prosessen med å autentisere en konsument.

Beskrivelse API

Dataobjekt som er en maskinlesbar beskrivelse av REST API-er iht. Open API Specification. Dette er formatet som benyttes for å registrere et API i felles API-katalog

API-søk

Tjeneste for å søke etter og finne tilgjengelige API-er

Få tilgang til data (konsument)

Evnen til å skaffe seg tilgang til tilbudte data fra annen aktør.

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

Tildel rettigheter til konsument

Datakonsument skal kunne finne tilgjengelige ressurser og be om tilgang til disse. Tilgang kan gis på grunnlag av eksisterende tillit til datakonsumenten eller per tilgangsforespørsel der ressurseieren beslutter tilgang.

API tilgangs-forespørsel

API eieren får forespørsel om den vil gi konsumenten tilgang til APIet.

UHF Autorisasjonstjener

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

UHF Konsumentregister

Oversikt over alle datakonsumenter som er blitt tildelt tilgang til ressurser.

Oversikten over konsumenters bruk av API fra datatilbydere er autoritativt for

  • hvilke OAuth2 scopes knyttet til hvilke API som konsumenten har fått tilgang til

Oversikten over konsumenters bruk av notifikasjoner fra datatilbydere er autoritativt for

  • datakonsumentens abonnement for notifikasjoner

OAUTH scopes

Dataobjekt som kan beskrives som en ressurs-definisjon, og et token er som regel knyttet til ett eller flere scopes. Scopes benyttes til å styre tilganger til API-er og operasjoner, samt eventuelt hva slags responser man får fra API-er.
Gå tilbake til standardvisning ved å klikke 'tilbake' (eller lukk dette vinduet om det er nytt)