Developer guide

Welcome to the developer guide for Altinn Broker! This part of the documentation will help you to get started using Altinn Broker, and how to best exploit the platform. Be aware that the documentation is still a work-in-progress, and that some sections are in a partial or incomplete state.

• Guide for Sender

  This developer guide will help you get started sending files using Altinn Broker.

• Guide for receivers

  This developer guide will help you get started receiving files using Altinn Broker.

• Altinn 3 Broker Developer guide for Service Owner

  How to get started with Altinn 3 Broker Service Owner API operations, for developers

• Altinn 3 Broker Developer guides

  How to get started subscribing to Events from Altinn 3 Broker, for developers

Since Altinn Broker is open source, you can access our code in our public github repo and build a local docker instance to test against.

We also welcome contributions to the solution.

See the readme file at github for an introduction to Altinn 3 Broker, and how to build and run it in your dev environment.

The Repo also contains a PostMan collection with examples.

Swagger for the File Transfer API is hosted here.

Overall API operation

To understand how the Broker API operates, including its dependencies and configuration steps, refer to the information below:

You need to have performed the steps in Getting started to setup the Access requirements.

Overall process

Overall process flow reflect the implemented reality of the file transfer process

All operations are asynchronous, unless otherwise noted. As such, you should implement Event subscriptions to make your process optimized instead of relying on polling for status.

Authentication

For all operations you will need to Authenticate using your Maskinporten Client then acquire an Altinn Token from Altinn Authentication.

Use the Altinn Token as a Bearer token for all Broker API requests along with the APIM subscription key as a header with the key Ocp-Apim-Subscription-Key.