Autentisering og autorisering skjer ved bruk av OAuth 2.0 med Fiks-integrasjoner og Maskinporten, som beskrevet her. Tilganger må tildeles integrasjoner på alle kontoene de skal ha lov til å utføre operasjoner for. Tilgang til en forsendelse autoriseres via avsenderkontoen.
Generell informasjon om feilmeldinger på Fiks-plattformen finnes her.
Sending av forsendelser: OpenAPI spec
Ved innsending av forsendelser anbefales det en timeout på 16 minutter. Dette for å håndtere innsending av større filer.
Innsending utføres ved bruk av en multipart HTTP request. Dette er ikke beskrevet i speccen. Første part må inneholde forsendelsens metadata, og ha navn “forsendelse”. Påfølgende parts skal inneholde dokumentene som skal sendes med forsendelsen. Disse må være i samme rekkefølge og ha samme navn som dokumentene definert i metadata.
Eksempel på en hvordan en slik request med to filer kan se ut:
POST /api/v2/kontoer/<konto-id>/forsendelser/ HTTP/1.1
Host: svarut.ks.no
Authorization: Bearer <Maskinporten-token>
IntegrasjonId: <integrasjon-id>
IntegrasjonPassord: <integrasjon-passord>
Content-Type: multipart/form-data; boundary=JettyHttpClientBoundarytt8xws4wfh61785q2obyg
--JettyHttpClientBoundarytt8xws4wfh61785q2obyg
Content-Disposition: form-data; name="forsendelse"
Content-Type: application/json;charset=UTF-8
{
"mottaker": {
"digitalId": "38850903357",
"navn": "fce655ae-8a8f-43ec-be63-78f7321f47fc",
"adresselinje1": "60b079d3-08a9-43fe-9ed8-b2ea6b5ddffb",
"poststed": "d6d164ad-c302-4464-bf6f-0e4d39c56181",
"postnummer": "0612",
},
"eksponertFor": [],
"avgivendeSystem": "3e0842fb-170f-49f2-9a39-345fee600e52",
"tittel": "5d624f2b-5eea-49ba-8d2d-dc6fa36e0d97",
"konteringskode": "0caae250-6c3d-4e37-a",
"utskriftskonfigurasjon": {
"utskriftMedFarger": false,
"tosidig": true
},
"dokumenter": [
{
"filnavn": "small.pdf",
"mimeType": "application/pdf",
},
{
"filnavn": "another.pdf",
"mimeType": "application/pdf"
}
]
}
--JettyHttpClientBoundarytt8xws4wfh61785q2obyg
Content-Disposition: form-data; name="name1"; filename="small.pdf"
Content-Type: application/octet-stream
... file data ...
--JettyHttpClientBoundarytt8xws4wfh61785q2obyg
Content-Disposition: form-data; name="name2"; filename="another.pdf"
Content-Type: application/octet-stream
... file data ...
Offentlige nøkler for kryptering:
TEST
PROD
Markering av forsendelser som lest eksternt: OpenAPI spec
Sletting av forsendelser: OpenAPI spec
Henting av status for forsendelser: OpenAPI spec
Henting av hendelser tilknyttet en forsendelse: OpenAPI spec
Henting av metadata tilknyttet en forsendelse: OpenAPI spec
Henting av forsendelser tilknyttet en ekstern referanse: OpenAPI spec
Henting av forsendelsestyper: OpenAPI spec
Henting av mottakersystem: OpenAPI spec
Vi har laget en klient som vi benytter internt, som også kan benyttes av andre i JVM-miljøer. Denne bruker genererte modeller fra OpenAPI spesifikasjonene. Koden kan finnes på GitHub. Ferdig bygget klient kan hentes fra Maven Central med ditt foretrukne byggeverktøy.
Dersom man ønsker å bygge sin egen klient kan det være utfordringer med å benytte en som er generert direkte fra spesifikasjonen for endepunktene som benytter seg av multipart HTTP-requests. Dette gjelder per nå kun for sende-APIet.