Altinn App API
- Veronika Andersen
- Øystein Thoen Sisjord
Denne siden er ment for å gir en oversikt over de viktigste API-ene som bør eller kan være nyttig å bruke i et søknadssystem.
Oversikt og forklaring på variabler brukt på denne siden:
Instanser
En instans er en potensiell innsending av tjenesten. Instanser vil være tilgjengelig for instanseier fra de blir opprettet og helt til de eventuelt blir slettet.
PartyId
Hver bruker har en unik identifikator i altinn - instanceOwner.partyId
Denne kan man finne ved å kalle endepunktety /parties med aktuelt ID-porten token.
GET {miljø}/dibk/{app}/api/v1/parties
Headers: {Authorization: bearer [Exchanged ID-porten]}
Se aktive instanser
Dette endepunktet kan benyttes for å avgjøre om en ny instans av en app skal opprettes eller om det er mer hensiktsmessig å fortsette utfylling av en eksisterende instans.
GET {miljø}/dibk/{app}/instances/{instanceOwner.PartyId}/active
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}Opprett instans
Hver innsending er en instans av en altinn 3 app.
POST {miljø}/dibk/{app}/instances
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}Multipart Request
Instanser kan og opprettes som multipart request der man laster opp data samtidig som man oppretter instansen
Se instans
Se informasjon om den aktuelle instansen.
Slett instans
Med tanke på sikkerhet bør data ikke lagres lenger enn nødvendig. Vi anbefaler derfor å rydde opp og slette instanser som ikke lenger er i bruk, enten fordi de er fullført eller ikke skal brukes mer. Sletting av instanser kan utføres både av instanseier og tjenesteeier. Dersom DiBK etablerer rutiner for sletting av instanser som tilsynelatende ikke er i bruk, vil dette bli dokumentert på de aktuelle tjenestenes egne sider.
Data elementer
Hver tjeneste har et sett med tillatte datatyper som kan være konfigurert på ulike måter.
Hvilke datatyper som finnes på den aktuelle appen, og hvordan de er konfigurert, finner man ved å kalle appen sitt API endepunkt:
allowedContributers : [org:dibk]
Dette er satt på datatyper som ikke er ment for sluttbruker å laste opp, men datatyper som dibk bruker for å tilgjengeliggjøre data for sluttbruker å lese.
Eksemspel på dette kan være valideringsrapport, signatur eller en signert PDF som dibk har produsert ut fra søknadsdata som er lastet opp av sluttburker.
Når en instans blir validert, enten ved å kalle valideringsendepunktet på appen eller som en del av prosessen ved "process next", vil appen sjekke om innholdet i instansen samsvarer med konfigurasjonen. I tillegg vil enkelte ting sjekkes allerede ved opplasting av dataelementer.
Utvidet filvalidering
Enkelte datatyper har “utvidet filvalidering” ved opplasting. De aktuelle datatypene er konfigurert med enabledFileValidators og enabledFileAnalysers.
Vi ser for oss å bruke dette på alle datatyper som forventer innhold i henhold til bestemte datamodeller og dermed kjøre en skjemavalidering. Eksempel hovedskjema og underskjema i en søknad.
Virus scanning
https://docs.altinn.studio/nb/app/development/configuration/filescan/
Enkelte datatyper har virus scanning ved opplasting. De aktuelle datatypene er konfigurert med "enableFileScan": true.
Foreløpig gjelder dette alle datatyper. Her kommer det endringer om vi ser det som unødvendig å kjøre for hver fil.
Last opp data
Oppdater data
Se data
Slett data
Legg til metadata om vedlegg
Se metadata på vedlegg
Du kan hente kun “User-defined-metadata”, men det vil og være synlig på dataelementet om man gjør en GET på instans
Det blir produsert en PDF av både hovedskjemaet og eventuelle underskjemaer. Brukerne skal kunne hente en forhåndsvisning av PDF-en før signering, samt en signert versjon når søknaden er sendt inn og signert av brukeren.
Forhåndsvisning
Det er forskjell om man henter ut forhåndsvisning av et hovedskjema eller underskjema.
Hovedskjema
Underskjema
Gjelder for datatyper som er definert som underskjema
Ved å kalle pdfpreview på et dataelement, vil du få en PDF-forhåndsvisning med data på det aktuelle dataelementet.
Signert PDF
Den signerte PDF-en blir tilgjengelig som et dataelement på instansen. Datatypen som brukes kan være konfigurert forskjellig i de ulike appene, så informasjon om dette vil være tilgjengelig på egne dokumentasjonssider for den aktuelle tjenesten.
Den signerte PDF-en blir produsert etter at det er gjort en Altinn-signatur og appen har gått videre til prosessens slutt (process end). Den signerte PDF-en vil deretter være tilgjengelig på den aktuelle datatypen, og man kan gjøre en GET-forespørsel på dataelementet for å hente den.
Altinn-signering
Signering er en prosessoppgave i Altinn Process actions – Altinn.
Signering utføres på følgende måte:
Validering
https://docs.altinn.studio/nb/api/apps/validation/
Validering skjer som en del av prosessflyten i Altinn-appen, men kan også kalles direkte på instansen eller på dataelementer.
Instansvalidering: Denne valideringen sjekker at instansen samsvarer med konfigurasjonen av datatyper i appen og kjører ekstra valideringer som er lagt til på enkelte datatyper.
Dataelementvalidering: For dataelementer som er av datatypene for hovedskjema og underskjema, har vi koblet på validering fra FtPB valideringstjeneste. Dette betyr at de samme valideringene som er tilgjengelige for pre-validering også blir kjørt her.
Responsen fra Altinn-appen vil være forskjellig fra responsen fra FtPB valideringstjeneste . Derfor lagrer vi responsen fra FtPB valideringstjenesten i en datatype som vi kaller Valideringsrapport, som kan hentes ved behov. Denne rapporten vil også bli sendt videre ved innsending av søknaden.
Vi anser ikke responsen fra Altinn som mangelfull, så det er fullt mulig å bruke denne responsen i stedet.
Pre-validering til FtPB valideringstjenesten er et tilbud som kan benyttes hvis det passer best inn i prosessflyten for det aktuelle søknadssystemet. Den samme pre-valideringen kan utføres ved å kalle appens valideringsendepunkter etter man har opprettet en instans og lastet opp data.
Dataelementvalidering
https://docs.altinn.studio//nb/api/apps/validation/#validate-stored-data
Endepunktet returnerer en liste med ValidationIssues, og det vil bli lagret en valideringsrapport på datatypen Valideringsrapport.
Filnavnet vil være Valideringsrapport-{datatype.id}-{dataElement.Id}.xml. Hvis det gjøres flere valideringer på samme dataelement, vil rapporten bli overskrevet.
Ved validering av et nytt dataelement av samme datatype, genereres en ny valideringsrapport.
Instansvalidering
https://docs.altinn.studio//nb/api/apps/validation/#validate-stored-instance
Endepunktet returnerer en liste med ValidationIssues basert på appen og dens konfigurasjon. I tillegg utføres alle relevante valideringer på alle dataelementer som er konfigurert for validering.
Mapping fra FtPB til Altinn sitt valideringsresultat
ValidationIssue (Altinn) | ValidationReport (FtPB) | Eksempel |
|---|---|---|
Severity | MessageType | Error |
DataElementId |
| Fra appen: |
Field | XpathField |
|
Code | Reference |
|
Description | Message |
|
Source | Settes av altinn, hvilke validator som er brukt. |
|
Fullfør innsending
https://docs.altinn.studio/nb/api/apps/process/#complete-the-process
Når instansen er satt til "process complete", blir data hentet og videresendt av FtPB arbeidsflyt.
Dette kan gjøres ved å kalle completeProcess eller process next når man står på siste steg.
Hvilke steg en app er i, ser man ved å gjøre en GET på instansen og se på innholdet i Process
Instance complete
Når tjenesteeier (DiBK) har hentet data og data er levert, setter de kaller de "complete" . Det betyr at tjenesteeier er ferdig og ikke lenger har bruk for dataene i instansen. Det samme kan instanseier (sluttbruker) gjøre når de er ferdig. Når både tjenesteeier og instanseier har gjort dette, vil altinn slette instansen og alle data knyttet til den.