Kommuneoppsett
Før en leverandør kan kalle Open Aidn-API-er på vegne av en kommune, må kommunen aktivere integrasjonen og konfigurere en OAuth-klient med de avtalte tilgangene.
Kommunale administratorer eller Aidn-administratorer utfører dette oppsettet i administrasjonsportalen.
Oversikt over oppsett
flowchart TD
A[Åpne kommunen i administrasjonsportalen] --> B[Åpne integrasjonsoversikten]
B --> C[Aktiver eller start integrasjonen]
C --> D[Opprett klient for leverandøren]
D --> E[Velg godkjente tilganger]
E --> F[Registrer leverandørens offentlige nøkkel]
F --> G[Del klient-ID og nødvendige konfigurasjonsverdier]
Integrasjonsstatus
Kommunen må aktivere integrasjonen før det kan opprettes en klient. Integrasjoner som er aktive eller under oppstart, kan ha tilknyttede OAuth-klienter.
Klientoppsett
Når en klient opprettes, bør administratoren gjøre følgende:
- Velge et tydelig klientnavn som identifiserer leverandøren og bruksområdet.
- Velge bare tilgangene som trengs for det godkjente bruksområdet.
- Registrere minst én offentlig nøkkel for klienten eller generere et nøkkelpar i administrasjonsportalen.
- Notere generert klient-ID og nøkkel-ID (
kid) slik at leverandøren kan hente tilgangstokener. - Hvis leverandøren bruker egen nøkkel, registrere bare den offentlige nøkkelen. Leverandøren skal beholde privatnøkkelen.
- Hvis administrasjonsportalen genererer nøkkelparet, overføre privatnøkkelen sikkert til leverandøren. Privatnøkkelen vises bare én gang og kan ikke hentes frem senere.
Konfigurasjon og testing for bruksområdet
De fleste integrasjoner trenger konfigurasjon som er tilpasset bruksområdet, både i Aidn og i tredjepartssystemet. Nøyaktige verdier og oppsettstrinn avhenger av det godkjente bruksområdet.
Kommunen bør bekrefte:
- Nødvendig konfigurasjon for bruksområdet er identifisert.
- Konfigurasjonen er utført i Aidn.
- Den tilsvarende konfigurasjonen er utført i tredjepartssystemet.
- Integrasjonen er testet med representative data og forventede arbeidsflyter.
- Kommunen, leverandøren og Aidn er enige om at oppsettet er klart for produksjonsstart.
Aidn bistår vanligvis med å sette opp testmiljøet og med den tekniske oppstarten. Kommunen utfører som regel ikke dette alene.
Driftsansvar
Kommunen og leverandøren bør avtale hvordan de håndterer:
- Rotering av nøkler og endringer i klientopplysninger.
- Endringer i konfigurasjonen for bruksområdet.
- Overvåking og feilsøking av mislykkede API-kall.
- Kontaktpunkter ved hendelser eller mistanke om at klientopplysninger er på avveie.