Dette avsnittet av dokumentasjonen er under arbeid. Det er deler som mangler eller bare delvis er dokumentert. Noen funksjoner representerer ikke den endelige produksjonsversjonen. Dette er felles steg som alle roller (tjenesteeier, avsendere og mottakere) må gjennomføre for å begynne å bruke Altinn Broker-komponenten.
1. Skaff deg en Altinn API-nøkkel For å bruke noen Altinn-API-er trenger du en abonnementsnøkkel for API-ene. Denne sendes som headeren Ocp-Apim-Subscription-Key i hvert forespørsel. »
Dette avsnittet av dokumentasjonen er under utvikling, og inneholder derfor omfattende referanser til eksterne kilder. Her er de detaljerte API-operasjonene og hendelsene du vil bruke når du sender filer.
Se også vår swagger-side.
Operasjon: Initialiser Filoverføring Endepunkt: POST /broker/api/v1/filetransfer/
Denne operasjonen initialiserer en filoverføring, inkludert validering av grunnleggende metadata og autorisasjon hvis mottaker(e) spesifisert er gyldige.
Forespørsel: En instans av FileInitializeExt serialisert som JSON.
Return: HTTP 200 med GUID-en FileTransferID som er den unike ID-en brukt til å identifisere denne filoverføringen. »
Denne delen av dokumentasjonen er under arbeid, og refererer derfor i stor grad 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. »
Denne prosessen vil forenkles gjennom en fremtidig oppdatering i Altinn Studio.
Spesielt vil trinn 4-6 utføres via GUI i stedet for å kreve direkte API-kall.
1. Kom i gang som tjenesteeier i Altinn For å komme i gang med Altinn Broker må bedriften din være registrert som en tjenesteeier i Altinn. For en trinnvis veiledning, se Kom i gang med Altinn-guiden.
Dette trinnet er bare nødvendig for nye bedrifter som ennå ikke har etablert seg som tjenesteeiere på Altinn-plattformen. »
Altinn 3 Formidling Utviklerguide for AvsenderHvordan komme i gang med å sende filer med Altinn 3 Formidling, for utviklere
Altinn 3 Formidling utviklerveiledningHvordan motta filer via Altinn Formidling
Altinn 3 Formidling - Utviklerveiledning for TjenesteeierHvordan komme i gang med Altinn 3 Broker Tjenesteeier API-operasjoner, for utviklere
Altinn 3 Formidling UtviklerguiderHvordan komme i gang med å abonnere på hendelser fra Altinn 3 Broker, for utviklere
Denne delen av dokumentasjonen er under arbeid. »
Denne delen av dokumentasjonen er under arbeid, og inneholder derfor omfattende referanser til eksterne kilder, samt beskrivelser av flere scenarier. Operasjon: Initialiser Tjenesteeier i Broker API Endepunkt: POST /broker/api/v1/serviceowner
Denne operasjonen konfigurerer organisasjonen din som en Tjenesteeier i Broker Config Store.
Forespørsel: En forekomst av ServiceOwnerInitializeExt serialisert som JSON.
Retur: HTTP 200
Utløste hendelser: ingen.
Eksempel: “Register Service Owner” i vår PostMan-samling.
Operasjon: Hent Tjenesteeierkonfigurasjon fra Broker API Endepunkt: GET /broker/api/v1/serviceowner »
Denne delen av dokumentasjonen er under arbeid, og refererer derfor i stor grad til eksterne kilder. For øyeblikket er hendelsene for Broker ikke klare for fullskala bruk, på grunn av kommende endringer i Altinn Events og Autorisasjon. Dette dokumenterer det forventede scenarioet, men kan endres. For å bruke hendelser/webhooks for en Broker-ressurs, må du sette opp et abonnement for den gitte ressursen. Dette abonnementet brukes til å konfigurere endepunktet der hendelsene som publiseres av megleren havner. »
På grunn av de ulike distinkte rollene som et foretak kan samhandle med Altinn Formidling, har vi delt inn veiledningene inn i flere deler for kurant rolle:
Sender/Avsender Recipient/Mottaker ServiceOwner/Tjenesteeier Et foretak kan ha én, eller en kombinasjon av alle tre rollene i henhold til konteksten.
Tjenesteeiere eier konfigurasjonen og datalagringen for Broker-tjenesteressursen, og vil opprettholde tilgangsrettighetene for sin spesifikke ressurs i Altinn Resource Rights Registry.
De fleste foretak vil ha Sender og/eller Mottaker, mens Tjenesteeiere ofte vil ha alle tre. »
