Developer guide

Welcome to the developer guide for Altinn Correspondence! This part of the documentation will help you to get started using Altinn Correspondence, 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.

• Altinn 3 Correspondence Developer guides

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

• Altinn 3 Correspondence Developer guides

  How to get started with Notifications in Altinn 3 Correspondence, for developers

Since Altinn Correspondence 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 Correspondenec, and how to build and run it in your dev environment.

The Repo also contains a PostMan collection with examples.

Swagger for the correspondence API is hosted here.

Overall API operation

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

Overall 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 Correspondence API requests along with the APIM subscription key as a header with the key Ocp-Apim-Subscription-Key.