Felles steg for å komme i gang med Altinn Formidling

Hvordan komme i gang med Altinn 3 Formidling, for både tjenesteeiere, avsendere og mottakere

Dette avsnittet av dokumentasjonen er under arbeid. Det er deler som mangler eller bare delvis er dokumentert. Noen funksjoner representerer ikke den endelige produksjonsversjonen.

Før du går i gang med spesifikke oppgaver som avsender, mottaker, eller tjenesteeier i Altinn Formidling, er det noen grunnleggende forberedelser og krav som gjelder for alle brukere. Denne seksjonen dekker de nødvendige stegene du må gjennomføre for å sikre en smidig og effektiv oppstart. Her vil du finne veiledning om generelle systemkrav, påloggingsprosedyrer, og grunnleggende oppsett som må være på plass før du kan begynne å bruke tjenesten fullt ut. Det er viktig at alle brukere følger disse instruksjonene nøye for å unngå problemer senere i prosessen.

1. Skaff deg en Altinn API-nøkkel

Først må du skaffe en abonnementsnøkkel fra Altinn. Når du sender en forespørsel til API-et, må du inkludere abonnementsnøkkelen i forespørselens Ocp-Apim-Subscription-Key header. Inkluderingen av abonnementsnøkkelen i forespørselen er nødvendig for at Altinn skal kunne verifisere at du har rett til å bruke API-et. Uten denne nøkkelen vil forespørselen din bli avvist. Dersom du mangler en API-nøkkel for Maskinporten-klientene du planlegger å bruke mot formidlingstjenesten, ta kontakt med oss på Altinn@Slack#produkt-formidling.

2. Registrer Maskinporten-klient med nødvendige scopes.

Registreringen av Maskinporten-klient med nødvendige scopes er viktig for å autentisere og sikre at du kan utføre nødvendige operasjoner via formidlings-API-et. Dette trinnet sikrer at kun autoriserte klienter kan sende og motta filer, og opprettholder dermed sikkerheten i tjenesten. For å autentisere mot Formidlings-API-et, må du registrere Maskinporten-klienten(e) din med de nødvendige scopene:

altinn:broker.write - For klienter som sender filer.
altinn:broker.read - For klienter som mottar filer.

Disse scopene vedlikeholdes av Altinn og må være autorisert for de riktige API-operasjonene, og er derfor uavhengige av tilgangen satt av tjenesteeiere for den spesifikke formidlingstjenesten.

Bruk Samarbeidsportalen for selvbetjent registrering. Følg den detaljerte guiden som er tilgjengelig der. Her er en detaljert guide.

3. Få tilgang til en bestemt tjeneste

For å få tilgang til en spesifikk formidlingstjeneste, må du kontakte tjenesteeieren og be om tilgang. Dette er med på å beskytte tjenesten mot uautorisert tilgang, og sikrer at kun legitime brukere kan operere tjenesten. (I fremtiden vil dette bli håndtert gjennom løsningen) Oppgi følgende informasjon:

Organisasjonsnummeret du vil representere
Systembrukeren

Dette vil i fremtiden håndteres av Systembruker / Ressurssregister / Tilgangslister via GUI.

Hvis du er en tjenesteeier som oppretter din første formidlingstjeneste, trenger du ikke følge dette steget. I stedet kan du gå videre til Tjenesteeier for en detaljert beskrivelse av hvordan du oppretter og administrerer formidlingstjenester.

4. Integrer mot Formidlings-API-et

Du er nå klar til å begynne integreringen mot Formidlings API-ene. For neste trinn se utviklerveiledningene.

5. Sett opp hendelsesabonnementer

For å kunne motta varsler om endringer eller hendelser knyttet til dine formidlingstjenester, må du sette opp et abonnement for den aktuelle tjenesten. Dette trinnet er spesielt viktig for deg som ønsker å få automatiserte varsler om hendelser fra formidlingstjenesten. Hvis du ikke trenger varsler, kan du hoppe over dette trinnet. Se utviklerveiledningen for events for detaljerte instruksjoner om hvordan du setter opp abonnementet.