Altinn 3 API
Beskrivelse av ulike Altinn API for sluttbrukere og applikasjonseiere.
API-ene
Altinn 3-løsningen har flere API-er, men de kan deles i to grupper: app-API-ene og plattform-API-ene.
App-API
Applikasjons-API er et API som gir tilgang til spesifikke forekomster av en spesifikk app. API-en gir funksjoner for å jobbe med dataelementer mens metadatadokumentet for forekomsten og dens dataelementer holdes oppdatert. Instansnivå-endepunktene dreier seg om å flytte en instans gjennom dens definerte prosess og kontrollere noen instansnivå-innstillinger.
Metadata for en app er den andre jobben til app-API-en. Det finnes endepunkter som gir tilgang til metadataene til selve appen, dens datatyper og prosessbeskrivelse.
Hver app vil eksponere nesten identiske endepunkter og funksjonalitet. Eksterne parter skal bare trenge én klientimplementering på tvers av alle app-API-er, men det er mulig for applikasjonseieren å utvide app-API-en med flere endepunkter og til og med gjøre endringer i standardfunksjonaliteten. Dokumentasjon for appspesifikk API og funksjoner må hentes direkte fra appen eller fra appeieren.
https://{org}.apps.altinn.no/{org}/{appname}
URL-en identifiserer appeierens spesifikke vertsnavn ved å bruke det korte navnet org, og identifikatoren til appen som består av både appeierens korte navn og navnet på appen. Å kombinere organisasjonen og appnavnet resulterer i det vi kaller app-ID-en org/appnavn.
Plattform-API
Plattform-API-ene er primært laget for å støtte applikasjonene som er vert på plattformen, men mange endepunkter kan brukes direkte av både applikasjonseiere og brukere. Primært på API-ene for autentisering, hendelser og lagring.
Storage API gir tilgang til alle instanser på tvers av alle applikasjoner. Den kan brukes til å få tilgang til metadata om applikasjoner, instanser, dataelementer og instansaktivitetslogg (hendelser), samt det faktiske datainnholdet. Denne API-en bør være den foretrukne metoden for appeiere for å laste ned data knyttet til instanser som er opprettet basert på deres apper. Applikasjonsbrukere kan bruke den hvis de trenger en form for meldingsboks eller ønsker å hente arkiverte instanser og deres data.
Autentiserings-API-et gir metoder for autentisering.
Events API gir tilgang til Events-komponentens endepunkt for oppføring av hendelser. Dette kan brukes sporadisk for å spørre Altinn etter hendelser som har oppstått i løsningen.
https://platform.altinn.no
API Brukergrupper
Det er primært to grupper brukere av Altinn API-er. Den første gruppen består av applikasjoner og systemer som brukes av eierne av appene som er vert for Altinn. Denne gruppen kalles Application Owners. Den andre gruppen består av organisasjoner og personer som bruker appene til å kommunisere med appeierne. Denne gruppen kalles Applikasjonsbrukere.
De to gruppene har mange like behov, men det er noen forskjeller i hva slags type oppgaver de skal utføre. Alle nye API-er er teknisk tilgjengelige for begge gruppene, men noen endepunkter har autorisasjon til å tillate bare én av gruppene.
Appeiere
Vanlige oppgaver for en appeier:
- Søk instanser for en gitt applikasjon i henhold til status eller forekomsteiere.
- Opprett en applikasjons-instans.
- Last opp skjemadata og vedlegg.
- Last ned skjemadata.
- Endre prosesstilstand (arbeidsflyt).
- Bekreft instansen som komplett.
Applikasjonsbrukere
Vanlige oppgaver for en applikasjonsbruker:
- Søk instanser for seg selv eller en part de kan representere (instanseier).
- Opprett en applikasjons-instans.
- Last opp skjemadata og vedlegg.
- Last ned skjemadata.
- Endre prosesstilstand (arbeidsflyt).
- Se status for en instans.
- Access Management
Beskrivelse av tilgjengelige API knyttet til Tilgangsstyring i Altinn 3
- App API
Standard-API-er eksponert av apper i Altinn 3
- Authentication API
Beskrivelse av hvordan systemer og tjenesteeiere kan benytte Maskinporten eller ID-porten for å få tilgang til API-er i Altinn 3
- Authorization API
Beskrivelse av hvordan systemer og tjenesteeiere kan benytte Maskinporten eller ID-porten for å få tilgang til API-er i Altinn 3
- Formidlingstjenesten
API for Altinn 3 formidlingstjeneste
- Guider
Her finner du guider for hvordan man kan integrere seg med Altinn API
- Meldingstjenesten
API for Altinn 3 Meldingstjeneste
- Modeller
Dette er en oversikt over de fleste modellene som brukes av de forskjellige API-ene. Den forklarer ikke hver eneste property i alle modeller, men forsøker å gi en solid introduksjon til de viktigste delene.
- Profil API
Beskrivelse av API-et til Profil-komponenten for Altinn Studio.
- Resource Registry API
Beskrivelse av API-et til Resource Registry-komponenten
- Scenarier
Forskjellige API-bruksscenarier
- Storage API
Beskrivelse av API-et til Storage-komponenten i Altinn 3-plattformen
- Altinn Studio Repository API
OpenAPI (swagger)-spesifikasjon for Altinn Studio