API: SvarInn REST

Her beskrives funksjonalitet for bruk av SvarInn V2. Dokumentasjon for tidligere versjoner finnes i versjonsoversikten.

Tilgang

Tjenesten bruker HTTP Basic autentication med brukernavn og generert service-passord. Mottakersystem opprettes av administrator hos KS Digital. Service-passordet genereres av person med tilgang via mottakersystem-siden. Dersom autentiseringen feiler returneres HTTP-status 401 Unauthorized, og ukjent URL gir HTTP-status 404. Detaljerte feilmeldinger følger også ved feil.

Henting og kvittering av forsendelser

Forsendelser er tilgjengelig for direkte import til sakssystem helt til de kvitteres ut. Dersom en forsendelse markeres som permanent feilet vil den gå videre i det normale løpet med varsling i Altinn og eventuelt fysisk post dersom den ikke leses digitalt og avsender har sagt at post til virksomheter skal ettersendes.

Dersom forsendelsen ikke er kvittert ut etter to timer vil denne bli inkludert i varsel-epost om manglende import, som sendes ut tre ganger om dagen.

API

Miljø Base URL
Test https://test.svarut.ks.no/api/
Prod https://svarut.ks.no/api/

Endepunkter og modeller er definert i OpenAPI-spec:
OpenAPI SvarInn V2 (Åpne i swagger editor)

Kryptering

Alle forsendelser som lastes ned via SvarInn er kryptert. For at dette skal fungere må den offentlige nøkkelen dere ønsker å bruke lastes opp til mottakersystemet i SvarUt med nivå 4-innlogging. Den private nøkkelen må være tilgjengelig i systemet som skal laste ned forsendelsene, slik at disse kan dekrypteres. I begge eksemplene under er disse filene kalt henholdsvis public.pem og privatekey.pem, og blir generert med en gyldighet på 99999 dager.

Unix

For å generere RSA nøkkelpar med OpenSSL kan følgende kommando brukes:
openssl req -x509 -newkey rsa:2048 -nodes -keyout privatekey.pem -out public.pem -days 99999

Windows

For windows kan man for eksempel laste ned denne OpenSSL-implementasjonen: https://slproweb.com/products/Win32OpenSSL.html
openssl req -x509 -newkey rsa:2048 -nodes -keyout privatekey.pem -out public.pem -days 99999 -config c:\<opensslinstallmappe>\bin\openssl.cfg