Sende post

Et fagsystem sender post gjennom SvarUt med REST-API-ene på denne siden. Har du ikke satt opp Maskinporten og Fiks-integrasjon ennå, start med Kom i gang.

Tilgang

Alle kall bruker Maskinporten og Fiks-integrasjon, som beskrevet på Integrasjoner. Integrasjonen må ha sendetilgang på SvarUt-kontoen. Den samme tilgangen gjelder for alle endepunktene under, også de som bare leser.

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

Sende en forsendelse

Det er ett endepunkt per type mottaker. Disse har forskjellige krav til hvilken informasjon som må sendes med.

Mottaker Endepunkt Krever
Privatperson POST /v3/kontoer/{kontoId}/forsendelser/person Gyldig fødsels- eller d-nummer
Virksomhet POST /v3/kontoer/{kontoId}/forsendelser/organisasjon Organisasjonsnummer som finnes i Enhetsregisteret
Helseaktør i Norsk Helsenett POST /v3/kontoer/{kontoId}/forsendelser/nhn Fødselsnummer til pasient med fastlege, eller HER-id. Se Norsk Helsenett
Rett til print POST /v3/kontoer/{kontoId}/forsendelser/print Postadresse

Spesifikasjon: forsendelse-send-api-v3.json (åpne i Swagger Editor)

Forsendelsen sendes som en multipart-request med metadata og dokumenter. Se Dokumenter og vedlegg for format, størrelsesbegrensninger og kryptering.

Svaret inneholder id til forsendelsen. Denne kan senere benyttes til sjekking av status, henting av hendelser, osv.

Bruk /print bare når mottakeren ikke kan nås digitalt. Papirpost koster mer og er dårligere for miljøet. Sender du til person eller virksomhet, går forsendelsen uansett til print hvis det ikke finnes en digital kanal, gitt at man ikke har bedt om kun digital levering. Se Kanalvalg.

Status

Utfyllende informasjon om hvilke statuser som eksisterer og hva de betyr finnes her.

Feilmeldinger

Feilmeldinger returneres som JSON med formatet beskrevet under Feilmeldinger. Ved behov for å kontakte brukerstøtte, inkluder errorId for å gjøre feilsøking enklere.

Klientbibliotek

fiks-svarut-klient er en klient for JVM-språk som KS Digital selv bruker. Den ligger på Maven Central.

Mer om sending