API Versioning
The API follows semantic versioning principles using a Major.Minor scheme. While we continuously deploy new functionality, breaking changes are carefully managed through version control. All changes are documented in the Changelog.
Legacy versions (version 0.1 and 0.2) are deprecated but remain available until 30.september.
Version Selection
Version 1.0
In version 1.0, it is obligated to set X-api-version in HTTP header to 1.0.
Version 0.2
To target version 0.2, include the X-api-version and X-api-key in HTTP header in your request.
Version 0.1
To target version 0.1, include the X-api-key in HTTP header in your request.
Most of current API users are still using version 0.1. If no version is specified, the request defaults to version 0.1. This is to keep current users from any code changes.
Authentication and authorization
Version 1.0 of this API uses HelseID and DPoP for authentication and authorization. To use this API version, you need a valid HelseID token with an appropriate scope. You can request access to this API version through the HelseID self-service portal.
Available scope: nhntsd:syntpop-api/full-access
Version 0.1 and 0.2 of this API uses API-key for authentication and authorization. API-key can be created in Syntpop Web application.
Note: Version 0.1 and 0.2 of the API will be turned off at 30.09.2026.
Migration from earlier versions to version 1.0
- Request access to the Syntpop API through the HelseID self-service portal. Save your private key for later use in your codes.
- Upgrade your application to send request with
X-api-versionanddpopheader. See code example in next section.
Code samples
Code sample demonstrating an API client that exchanges a valid token from HelseID and makes requests to the SyntpopAPI version 1.0 are available here:
Disclaimer: This sample is provided for reference only and is not actively maintained. It should be used as inspiration rather than production-ready implementation.