Anbefalt integrasjon - OnDemand oppslag med bruk av Idrettens ID
Introduksjon
Denne siden viser en anbefalt integrasjon der tilgangen til tjenestene hos NIF kan berike opplevelsen til personen som logger inn med Idrettens ID. F.eks ved at personen skal melde på seg selv, eller barnet sitt på en konkurranse. Når brukeren logger seg inn med Idrettens ID vil man kunne spørre om mer informasjon “on demand”. Integrasjonspartneren vil da alltid få de riktige opplysningene og tilhørighetene i idretten.
Tilgang til de ulike API metodene gis basert på behovene som er i tredjepartsapplikasjonen som benyttes.
Informasjonsflyt ved påmelding
Eksempelet viser samspillet mellom tjenester i et scenario hvor en person skal melde på seg selv eller et eller flere barn.
Idrettens ID og direkteoppslag
Grunnstenen til våre tjenester er Idrettens ID. Med denne tjenesten for autentisering trenger man ikke lengre å lagre mer informasjon enn man trenger eller ønsker. NIF vil i alle tilfeller kreve implementering av idrettens ID og at dette benyttes som primær innloggingsmetodikk for aktøren som ønsker tilgang til data.
Dokumentasjon og endepunktlinker
Link til dokumentasjon og tjenester som er aktuelle i dette eksempelet,
Metode / Tjeneste | Forklaring | Utfyllende dokumentasjon |
---|---|---|
Idrettens ID | Metodikk for pålogging og identifisering av personen | |
PersonInfo | Get metode for å hente ut kontaktopplysninger | |
PersonRole/Person | Get metode for å hente personens roller og tilhørighet i et Organisasjonsledd. | |
PersonRole/Membership | Get metode for å hente personens medlemsskap og tilhørighet i et Organisasjonsledd. | |
PersonActivityTeams | Get metode for å finne tilhørende lag for personen | |
LicenseCheck | Get metode for å hente ut lisensopplysninger for en person (kun gyldig for særforbund som bruker idrettens lisensløsninger) | |
PersonRelation / Childrelations | Metode for å hente ut personid’er til barn eller personer man er verge for. Denne tjenesten er også endel av idrettens ID | |
|
|
|
Søk etter medlemmer
Enkelte idretter krever at en påmeldingsansvarlig o.l melder opp deltagere til konkurranse. Med metoden AT - personSearch kan man bruke flyten som beskrevet på denne siden, men da først søke opp personen man ønsker å melde på, forså å utføre f.eks lisenssjekk o.l på personen. Søket krever at man har riktig rolle i organisasjonsenheten man søker i.
Tilgangskontroll
Tilgangen til oppslagsmetodene som inneholder aktivitet og personopplysninger vil bli gitt med et tilpasset scope. Det betyr at man får tilgang til personer som er knyttet til formålet. F.eks om man har påmelding til et tennis arrangement, i et tennis system, så vil tilgangen være gitt basert på at man har en avtale med Norges Tennisforbund, og kun personer knyttet til dette forbundet vil være mulig å slå opp med tilgangen man har fått.