Last modified: Jun 28, 2024

Broker

About Altinn 3 Broker Transition Solution

What is the Altinn 3 Broker Transition Solution For broker service owners whose end users are reliant on using Altinn 2, but who wish to migrate their broker service to Altinn 3, Altinn is offering a Transition service. This enables communication between senders and receivers of files regardless of which Altinn Broker service they are integrated to. This service will allow service owners to link an existing Altinn 2 service to an Altinn 3 resource, and to forward Altinn 2 Broker Service requests to the Altinn 3 Broker Service app while not substantially changing the Altinn 2 Broker Service End User experience. »

Getting started with Altinn Broker Transition Solution

ServiceOwners In order to use the Broker Transition solution in Altinn 2 to create, upload and retrieve file metadata, a service owner must complete the following steps. Have an existing Altinn 2 Broker Service. Have or create a corresponding Altinn 3 Broker Resource. See how to get started with Altinn Broker here. Request a transition setup from the Altinn 2 Service to the Altinn 3 Resource. Determine the date for when this should go live. »

Technical Overview

About The Altinn 3 Broker Transition service bridge is an internal component in Altinn 2 that transfers Broker requests from Altinn 2 to Altinn 3 for a given request, based on the ServiceCode/ServiceEditionCode combination of the request. This is an implementation of the soft shift solution described here. Technical overview Altinn 2 allows end users in Altinn 2 to make BrokerService requests for specific Broker Services that will be transferred to Altinn 3 instead of being stored in Altinn 2. »

Usage

These pages describe the difference in usage between existing Altinn 2 Broker Service and Altinn 3 Broker Transition operations. Usage RestDifference in Rest operation usage between Altinn 2 and Altinn 3 transitioned services. Usage SOAPDifference in SOAP operation usage between Altinn 2 and Altinn 3 transitioned services. »

Usage Rest

Difference in usage between existing Altinn 2 Rest Operations and Altinn 2 Rest operations that have been transition to Altinn 3. For standard usage of Altinn 2 Rest operations, see [Altinn Docs (norwegian only)] (https://altinn.github.io/docs/api/rest/formidling/) For all Altinn 3 transitioned services, Receipts will be pseudo-receipts generated from the Altinn 3 file metadata. This means all receipts returned will be pseudo-receipts, and all receiptIds will be 0. If your use case requires receipt usage, please submit a feature request. »

Usage SOAP

Difference in usage between existing Altinn 2 SOAP Operations and Altinn 3 SOAP operations that have been transition to Altinn 3. SOAP operations for Altinn 2 Broker Service are spread over 3 endpoints. For most requests there will be no functional difference between Altinn 2 and Altinn 3 requests. Service Endpoint Description BrokerService Service WS Handles metadata requests. Service Basic Service EC BrokerService Streamed Streamed WS Handles file data requests. Streamed Basic Streamed EC Receipt Receipt WS Handles receipt requests. »

Common steps to get Started with Altinn Broker

This section of the documentation is a work in progress. There are sections with missing or only partial documentation. Some functionality does not represent the final production version. These are common steps that all roles (Service Owner, Senders and Recipients) need to complete in order to start using the Altinn Broker component. 1. Get an Altinn API Key In order to use any Altinn APIs, you need a subscription key for the APIs. »

Altinn 3 Broker Developer guide for Sender

This section of the documentation is a work in progress, and as such currently makes extensive reference to external sources, as well as describing more scenarios. Here are the detailed API operations and events you will be using when sending files. See also our swagger page. Operation: Initialize FileTransfer Endpoint: POST /broker/api/v1/filetransfer/ This operation initializes a File Transfer, including validating basic metadata and authorizing if the recipient(s) specified are valid. »

Altinn 3 Broker Developer guides

Altinn 3 Broker Developer guide for SenderHow to get started sending files with Altinn 3 Broker, for developers Altinn 3 Broker Developer guidesHow to get started Receiving files with Altinn 3 Broker, for developers Altinn 3 Broker Developer guide for Service OwnerHow to get started with Altinn 3 Broker Service Owner API operations, for developers Altinn 3 Broker Developer guidesHow to get started subscribing to Events from Altinn 3 Broker, for developers »

Altinn 3 Broker Developer guides

This section of the documentation is a work in progress, and as such currently makes extensive reference to external sources. Here are the detailed operations and events you will be using when Receiving files. Operation: Get FileTransfers Endpoint: GET /broker/api/v1/filetransfer/(filters) Allows you to search for file transfers according to set filters, and returns a list of FileTransferIds matching the search criteria. You can then use these Ids to get FileTransfer Overview and download. »