Formidling Komme i gang Utviklerveiledning Motta filer

Veiledning for mottakere

Denne guiden hjelper deg med å komme i gang med å motta filer ved hjelp av Altinn Formidling.

Merk at denne delen av dokumentasjonen fortsatt er under arbeid og derfor i stor grad refererer til eksterne kilder.

Operasjon: Hent filoverføringer

Endepunkt: GET /broker/api/v1/filetransfer/(filtre)

Lar deg søke etter filoverføringer i henhold til angitte filtre, og returnerer en liste over FileTransferIds som matcher søkekriteriene. Du kan deretter bruke disse ID-ene til å hente filoverføringsoversikt og laste ned.

Denne operasjonen bør brukes sparsomt, da man bør fokusere på webhook/event/hendelse published for å varsle deg om filoverføringer som blir tilgjengeligjort til deg.

Forespørsel: Filtre spesifisert i URL-en:

resourceId - ressurs-ID brukt til å verifisere tilgang til formidlingstjenesten, påkrevd.
status - gjeldende status for filoverføringen.
recipientStatus - gjeldende status for deg som mottaker.
from - DateTimeOffset for å filtrere fra.
to - DateTimeOffset for å filtrere til.

Når du søker etter filer du ikke har lastet ned som mottaker, spesifiser følgende:

resourceId - ressurs-ID brukt til å verifisere tilgang til formidlingstjenesten
status = “published”
recipientStatus = “initialized”

Respons: En liste over FileTransferIds i GUID-format.

Eksempel:

‘Broker\search’ i vår Postman-samling.

Hendelser utløst: Ingen.

Operasjon: Hent filoverføringsoversikt

Endepunkt: GET /broker/api/v1/filetransfer/{fileTransferId}

Få en enkel oversikt over filoverføringen med relevant metadata og gjeldende status og mottakerstatus. Du kan bruke enten FileTransferId fra published hendelse eller fra søk.

Respons: En JSON-seralisert versjon av FileTransferOverviewExt.

Hendelser utløst: Ingen.

Eksempel: ‘Broker{fileTransferId}\overview’ i vår Postman-samling.

Operasjon: Last ned fil

Endepunkt: GET /broker/api/v1/filetransfer/{fileTransferId}/download

Last ned fildataene som en strøm ved hjelp av FileTransferId mottatt fra oversikt.

Forespørsel: FileTransferID spesifisert i URL-en, og dataene som en strøm.

Returner: En binær strøm som inneholder fildataene.

Hendelser utløst: Ingen

Eksempel: ‘Broker{fileTransferId}\download’ i vår Postman-samling.

Operasjon: Bekreft nedlastet

Etter at du har lastet ned og behandlet filen vellykket, må du bruke denne operasjonen for å varsle løsningen om at filen er levert. Dette vil oppdatere statusen for filoverføringen, og potensielt slette fildataene i henhold til innstillingene på formidlingstjenesten.

Endepunkt: POST /broker/api/v1/filetransfer/{fileTransferId}/confirmdownload

Last opp fildataene som en strøm ved hjelp av FileTransferId mottatt i InitializeFileTransfer.

Forespørsel: FileTransferID spesifisert i URL-en.

Returner: HTTP 200 hvis vellykket gjennomført.

Hendelser utløst:

downloadconfirmed.

Eksempel: ‘Broker{fileTransferId}\confirm download’ i vår Postman-samling.

Hendelse: no.altinn.broker.published

Denne hendelsen utløses når den asynkrone opplastingsbehandlingsprosessen har blitt fullført vellykket.

Som mottaker kan du deretter bruke FileTransferId spesifisert i resourceinstance for å starte nedlastning av metadata og filinnhold.

Hendelse: no.altinn.broker.downloadconfirmed

Denne hendelsen utløses når du har bekreftet at nedlastingen er fullført vellykket, og den sendes også til avsenderen. Du trenger ikke å utføre handlinger mot Formidling, men det er en ekstra bekreftelse på at ConfirmDownload har gått vellykket, og du kan velge å bruke dette til å utløse en intern prosess på din side.

Hendelse: no.altinn.broker.fileneverconfirmeddownloaded

Denne hendelsen utløses ved utløpstiden for filoverføringen i tilfelle en eller flere mottakere ikke har bekreftet nedlastingen av filen. Dette kan indikere at enten mottakeren ikke har vært klar over filoverføringen, eller at de har lastet ned, men forsømt å kalle ConfirmDownload. Denne hendelsen sendes også til de mottakere som ikke har bekreftet nedlastingen.