Kommuneoppsett

Før en leverandør kan kalle Open Aidn API-er for en kommune, må integrasjonen aktiveres for kommunen og en OAuth-klient må konfigureres med avtalte scopes.

Dette oppsettet gjøres av kommunale administratorer eller Aidn-administratorer 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 scopes]
    E --> F[Registrer leverandørens offentlige nøkkel]
    F --> G[Del client ID og nødvendige konfigurasjonsverdier]

Integrasjonsstatus

Integrasjonen må være aktivert for kommunen før det kan opprettes en klient for den. En integrasjon som er aktiv eller under oppstart kan ha OAuth-klienter knyttet til seg.

Klientoppsett

Når en klient opprettes, bør administratoren:

• Bruke et tydelig klientnavn som identifiserer leverandør og bruksområde.
• Velge bare scopes som trengs for det godkjente bruksområdet.
• Registrere minst én offentlig nøkkel for klienten, eller generere et nøkkelpar i administrasjonsportalen.
• Notere generert client ID og key ID (kid) slik at leverandøren kan hente tokens.
• 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 spesifikk for bruksområdet, både i Aidn og i tredjepartssystemet. Nøyaktige verdier og oppsettsteg avhenger av det godkjente bruksområdet.

Kommunen bør bekrefte:

• Nødvendig bruksområdespesifikk konfigurasjon er identifisert.
• Konfigurasjonen er utført i Aidn.
• Tilsvarende konfigurasjon 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 produksjonssetting.

Aidn vil normalt bistå med oppsett av testmiljø og teknisk oppstart. Dette er vanligvis ikke noe kommunen utfører alene.

Driftsansvar

Kommunen og leverandøren bør avtale hvordan de håndterer:

• Nøkkelrotasjon og endringer i credentials.
• Endringer i bruksområdespesifikk konfigurasjon.
• Overvåking og feilsøking av API-kall som feiler.
• Kontaktpunkter ved hendelser eller mistanke om kompromitterte credentials.