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]}

Utvid
title PartyId er en del av instans.id og tilgjengelig i instans objektet
Image Added

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.

https://docs.altinn.studio/nb/api/apps/instances/#get-active-instances

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.

...

GET {miljø}/dibk/{app}/instances/{instance.id}
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

Slett instans

https://docs.altinn.studio/nb/api/apps/instances/#delete-instance

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.

DELETE {miljø}/dibk/{app}/instances/{instance.id}
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

Data elementer

Hver tjeneste har et sett med tillatte datatyper som kan være konfigurert på ulike måter.

...

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.

Last opp data

https://docs.altinn.studio/api/apps/data-elements/#upload-data

...

DELETE {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id}
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

Metadata

Status
colour Yellow title under arbeid

Det skal være mulig å laste opp metadata på dataelementer.
Dette er ment å erstatte “vedleggsopplysninger” fra altinn2 løsningen.

Metadata vil være av typen “key-value” og key verdien vil bli validert mot et sett med lovlige verdier.
Mer informasjon kommer når løsningen er klar.

PDF

Vi har ikke tatt i bruk Altinn sin PDF-generering, men utviklet vår egen løsning for dette.

...

Legg til metadata om vedlegg

PUT {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id}/user-defined-metadata
Headers: {Authorization: bearer [Exchanged ID-porten eller Maskinportentoken]}

Body: 
{
  "userDefinedMetadata": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

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

GET {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id}/user-defined-metadata
Headers: {Authorization: bearer [Exchanged ID-porten eller Maskinportentoken]}

Respons: 
{
  "userDefinedMetadata": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

PDF

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.

Hver app konfigureres med hvilke datatyper det produseres PDF av, men denne informasjonen er ikke tilgjengelig i appens metadata da dette ikke er en del av Altinn-løsningen. Informasjonen skal i stedet være tilgjengelig på egne dokumentasjonssider for den aktuelle tjenesten.

Forhåndsvisning

Man kan få en forhåndsvisning av PDF-en ved å kalle pdfpreview på enten instansen eller på det aktuelle dataelementet.

Forhåndsvisning på instansen: Ved å kalle pdfpreview på instansen, vil du få en PDF-forhåndsvisning med data på den datatypen som er konfigurert som hovedskjemaet for appen

Forhåndsvisning

Det er forskjell om man henter ut forhåndsvisning av et hovedskjema eller underskjema.

Hovedskjema

GET {miljø}/dibk/{app}/instances/{instance.id}/pdf/pdfpreviewpreview
Headers: {
          Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]
         }

...

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, dersom datatypen er konfigurert for PDF-generering.

GET {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id}/pdfpreview
Headers: {
          Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]
         }

...

Signert PDF

Den signerte PDF-en blir tilgjengelig som et dataelement på instansen. Datatypen som brukes vil 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.

GET {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id} // Signert pdf
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

Altinn-signering

...

Signering er en prosessoppgave i Altinn https://docs.altinn.studio//nb/altinn-studio/reference/process/actions/process-actions/#sign.

...

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

...

...

Når instansen er satt til "instance process complete", blir data hentet og videresendt av FtPB arbeidsflyt.

...

PUT {miljø}/dibk/{app}/instances/{instance.id}/process/completeProcess
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

Slett instans

Status
colour Red title Mer info kommer

Legg til ?hard=true om en ikke vil benytte søppelkasse funksjonene i Altinn.

...

Hvilke steg en app er i, ser man ved å gjøre en GET på instansen og se på innholdet i Process

GET {miljø}/dibk/{app}/instances/{instance.id}
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

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.

POST {basePath}/{instanceOwnerPartyId}/{instanceGuid}/complete 
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}