API: Versjonsoversikt

Viktig informasjon

Vi avvikler støtte for alle gjenværende SOAP-versjoner og REST v1 i 2027. SOAP-versjonene har fått sluttdato 1.1.27, mens REST v1 blir avviklet 31.7.2027, les mer her.

Vi har også lagt til støtte for å automatisk opprette integrasjoner som kan brukes for kall til REST v2/v3 - du kan lese mer om det her.

REST API-er

Det kommer ikke ny funksjonalitet for SOAP-servicen etter V11. Nye endringer og features vil komme i REST-servicene. Dersom JSON-strukturen bli forandret vil det komme en ny versjon av servicen. Alle implementasjoner må takle at det kan legges til nye JSON-felt, og at eksisterende ikke-obligatoriske felt kan forsvinne.

API	Versjon	Status	Dato for avvikling	Endringer
Send (spec)	V3	Stabil	-	Sending av forsendelser til mottakere i Norsk Helsenett (NHN) Separate endepunkter for sending til forskjellige mottakertyper (person, organisasjon, NHN, direkte til print)
Send (spec)	V2	Erstattet	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Lest (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Slett (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Status (spec)	V3	Stabil	-	Lagt til nye statuser for V3 API.
Status (spec)	V2	Erstattet	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Hendelser (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Metadata (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Ekstern ref (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Typer (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
Mottakersystem (spec)	V2	Stabil	-	Benytter Fiks integrasjonsautentisering og Maskinporten Endepunkter gruppert slik at de kan versjoneres hver for seg
REST (felles) (docs)	V1	Planlagt avviklet	31.12.2026	Funksjonaliteten i SOAP V11 flyttet til REST basert API

SOAP API-er

NB! Vi planlegger å avvikle støtte for alle gjenværende SOAP-versjoner i løpet av 2026, les mer her.

For utsending av forsendelser via KS-SvarUt kan man benytte en SOAP basert web-service. Denne servicen mottar forsendelsen og relevante metadata, og besørger videre ekspedering via elektroniske meldingstjenester eller vanlig post.

For å sikre bakoverkompabilitet versjoneres servicen. Når grensesnittet endres deployes en ny versjon slik at eksisterende klienter selv kan velge når de ønsker å ta i bruk ny versjon. Se tabell under for hvilke versjoner som til enhver tid er støttet. Hver versjon dokumenteres separat. Deprecated bør ikke brukes i nye integrasjoner.

Kall mot SvarUt, timer ut hvis de tar mer enn 15 minutter. Derfor kan det være lurt å ha timeout på tilkoblingen som er lenger enn dette. Da får avsender ikke timeout uten at den er initiert av SvarUt. Ellers kan avsender risikere å ikke få forsendelseID på forsendelser som har gått ok.

Versjon	Status	Dato for avvikling	WSDL	Endringer
ForsendelseServiceV1	Avviklet	25.03.2021
ForsendelseServiceV2	Avviklet	25.03.2021		Støtte for mottakeradresse ihht NOARK5 (inkl. Land) Ny metode for å hente historikk for en spesifikk forsendelse Kun digital levering (dvs. dokumenter som ikke skal til print) Støtte for giroark i forsendelse Ny metode for å sette status lest fra eksternt system
ForsendelseServiceV3	Avviklet	25.03.2021		Støtte for lenker i forsendelser Støtte for metadata til bruk i automatisk import service
ForsendelseServiceV4	Planlagt avviklet	31.12.2026	WSDL	Støtte for krypterte forsendelser Utvidede metadata til bruk i automatisk import service Støtte forsendelser som krever nivå4-innlogging
ForsendelseServiceV5	Planlagt avviklet	31.12.2026	WSDL	Kan fylle ut SvarSendesTil for å gi informasjon om hvem svar på forsendelsen skal sendes til. Dette blir brukt som avsenderadresse på postlagt brev også. Kan spesifisere om dette er et svar på en tidligere forsendelse. Lagt til dokumentType for å si hvilken type forsendelse dette er(blir renamet til forsendelseType i v7) Eksternref en id som kan brukes til å finne forsendelser
ForsendelseServiceV6	Planlagt avviklet	31.12.2026	WSDL	Kan legge med svar på forsendelse link, slik at mottaker kan svare på forsendelsen. Søke opp forsendelseid basert på eksternref
ForsendelseServiceV7	Planlagt avviklet	31.12.2026	WSDL	dokumentType heter nå forsendelsetype Støtte for Digdir sin signeringstjeneste. Beskrivelse av Signeringstjeneste
ForsendelseServiceV8	Planlagt avviklet	31.12.2026	WSDL	dokumentType lagt til på hver fil. Denne er tilgjengelig i Svarinn. Kan hente liste med mottakersystem for et orgnr Kan hente forsendelseTyper som kan brukes i SvarUt
ForsendelseServiceV9	Planlagt avviklet	31.12.2026	WSDL	Hente ut signeringshistorikk på en forsendelse Dokument har fått ekskluderesFraPrint, da er ikke filen med i print av forsendelsen. Brukes typisk til filer som kun er interesange om forsendelsen lastes ned digitalt. Xml, lyd, video filer osv.
ForsendelsesServiceV10	Planlagt avviklet	31.12.2026	WSDL	Ny operasjon: retrieveDokumentMetadata. Denne er lagt inn for å kunne hente ut informasjon om bl.a. hvor dokumentet kan lastes ned og eventuelt lenke til signeringsoppdrag. Endret operasjon: setForsendelseLestAvEksterntSystem. Denne er oppdatert til å ta imot objekt av type LestAv. Endret operasjoner: retrieveForsendelsesStatus og retrieveForsendelsesStatuser, begge returnerer nå samme modell-objekt (ForsendelsesStatus). Sistnevnte operasjon har pakket resultatet i en liste. Forsendelsesid og organisasjonsnummer er kapslet inn i egne typer. Modell-objektet StatusResult heter nå ForsendelsesStatus. Gamle ForsendelseStatus heter nå Status og blir returnert som en del av ForsendelsesStatus. Modell-objektet Brevpost er ikke lenger i bruk og er fjernet. Modell-objektet PrintKonfigurasjon heter nå UtskriftsKonfigurasjon. Alle modell-objektene er oppdatert til å bruke camelCase på felt og attributter.
ForsendelsesServiceV11	Planlagt avviklet	31.12.2026	WSDL	EksponertFor, kan gjør forsendelse tilgjengelig for andre enn mottaker. Brukes av edialog for å tilate innsender å laste ned filene.

Nedlasting av forsendelser direkte til sakssystem

Sakssystemer kan kalle SvarUt for å laste ned forsendelser direkte via REST API.

Dokumentasjon	Spesifikasjon	Status	Endringer
SvarInn V1	OpenAPI	Deprecated
SvarInn V2	OpenAPI	Stabil	Endepunkter for oppdatering av status slått sammen Endret navn og type på enkelte felter Nye felter for Noark-metadata