Altinn Broker ("Formidlingstjenesten")

Altinn Broker is a Managed File Transfer (MFT) service for secure file transfer between organizations in Norway.

Getting started

Altinn Broker is currently available in Altinn's staging environment at https://platform.tt02.altinn.no. In order to get started integrating to the API, follow our guide on getting started and implement according to our Swagger specification.

Postman

Example requests using postman can be found in altinn-broker-postman-collection.json. In order to use it, you need to register a Maskinporten integration with the scope "altinn:testtools/tokengenerator/enterprise" and use it to fill out the Postman variables "client_id", "client_kid" and "client_jwk". Also set the variable "serviceowner_orgnumber". After that, run all the requests in the folder Authenticator in order. This will authenticate you to to run all the other requests in the collection.

The first time you start testing in an environment, you need to register a service owner in Broker so that we can provision the necessary storage resources for you. Use the "Register Service Owner" request in the Postman collection to do this. Make sure you have run the Authenticator/"Authenticate as service owner (tjeneste-eier)" request first.

Finally, you need to register a resource in the Resource Registry. First set the Postman variable resource_id to some unique ID. You can then use the requests in the Resource Registry folder with the test policy to create and manage the resource. As with registering a service owner, you need to have authenticated as a service owner to make these requests.

Local Development

The start.ps1 script runs all neccassary commands to run the project. If you want to run the commands seperate, you can follow the steps below:

The services required to support local development are run using docker compose: docker compose up -d

To support features like hot reload etc, the app itself is run directly. Either in IDE like Visual Studio or by running: dotnet watch --project ./src/Altinn.Broker.API/Altinn.Broker.API.csproj

Installing Dotnet 8.0 is a pre-requisite.

Azurite

When running tests or when running locally, we use the Azurite storage emulator to emulate an Azure Storage account locally. You can use Azure Storage Explorer to inspect the blob contents.

Migrations

The solution uses Flyway to run migrations. The migration scripts can be found in /src/Altinn.Broker.Persistence/Migrations. Script naming must follow the convention "V${four-digit-version-number}__${name}". If you need to re-initialize the database during local development, you can delete the database container and re-run docker compose.

When running locally for development, you can use any Maskinporten token. It is not validated.

Formatting

Formatting of the code base is handled by Dotnet format. See how to configure it to format-on-save in Visual Studio here.

Deploy

The solution uses Github actions to deploy. When a branch is merged to main, the CI/CD workflow will deploy it to the internal test environment (https://altinn-dev-api.azure-api.net) where the developer can test it. They then have to return to the workflow and approve it for further deployment to staging and production.