Technical documentation for the implementer of the integration (API version 12)
Beta – content under developedInterface versions of the Finnish Service Catalogue
The search interface of the FSC API version 12 was published in the production environment as a beta version in March 2026.
Read more about the architecture reform and the plan for changing the interface versions
API version | 2026 | 2027 |
|---|---|---|
API version 11 | supported | Discontinued in April 2027 (date to be specified). |
API version 12 | The search API (beta) was put into production in March 2026. The final search API version will be put into production in November 2026. Once this is done, no further changes will be made to the search API that would require changes in existing integrations. | The import API will be put into production in April 2027 (date to be specified). |
Basic information about the FSC interface
The Finnish Service Catalogue has an open REST/JSON interface. The data is disclosed for free under the CC0 licence, which allows unrestricted further use.
Starting in API version 12, you will need an API key for using both the search and import APIs.
We provide a self-service for generating API keys. Keys are usable immediately after creation. Notify the contact details of your organisation to the Digital and Population Data Services Agency when you begin using your key. We use these contact details to communicate disruptions in the API.
Read API key user guide for API version 12.
Location data for organisations and service locations use the EPSG:3067 coordinate reference system.
Make sure to always use the most recent version of the API when creating a new integration.
Search API
The search API is for exporting data from the FSC. If you are working on an export integration, review the following instructions:
- More information for the implementers of the search integration (API version 12)
- Transition from API version 11 to 12 (search and import API)
Import API
The import API allows users to import data from another system into the FSC. The import API requires a separate access licence.
If you are working on an import integration review the following instructions:
- More information for implementers of the import integration (API version 12) (in Finnish)
- Transition from API version 11 to 12 (search and import API)
- Business rules for the interpretation of API data
- How to deploy the import interface (IN interface)
Data model
The Finnish Service Catalogue contains customer-oriented descriptions of services and the details of the service channels related to them, as well as the connection information between them. It is also possible to export information about organisations that have described their services.
Before you begin working on your integration, carefully review the following.
- The concept of the FSC, which describes the Finnish Service Catalogue and what it’s used for.
- The data model overview, which describes the key concepts of the FSC and the links between them.
- The FSC’s logical data modelOpens in a new window., which describes the structures and relations of the data model in detail.
Interface documentation in Scalar
The API calls and their usage instructions are available separately for each environment:
- API documentation of the customer test environment (Scalar)Opens in a new window..
- API documentation of the production environment (Scalar)Opens in a new window..
The API calls are grouped into two entities in the documentation: content data and reference data.
Content data (core) includes the following API calls to FSC content:
- services
- service channels
- connections
- organisations
- general descriptions
- service collections.
Reference data includes:
- codelists
- classifications, and
- other reference data.
Using the API calls
- Retrieve data with the GET methods
- Add data with the POST methods
- Update data with the PUT methods
- Archive data with the DELETE methods
Make sure to use your API key with all calls. Use of the POST, PUT and DELETE methods also requires a licence for the import interface, see How to deploy the IN-interface.
FSC’s source code
The FSC’s source code is currently not publicly available in GitHub. If you need the source code to help with implementing an integration or for technical clarification, send a request to ptv-tuki@dvv.fi.