Deployment

You can import data from your organisation’s register to the Suomi.fi Web Service for the end user to view by completing the following deployment steps. We recommend reserving four months for the deployment.

Deployment steps

1. Read the materials on the Web Service

Read the instructions in the Registers section carefully.

2. Accept the terms of use

Notify the Digital and Population Data Services Agency that your organisation wants to connect its register to the Web Service. Email the notification to verkkopalvelu-kayttoonotot@dvv.fi.

In the same message, state that your organisation accepts the terms of use of the Web Service:

Suomi.fi-palvelunäkymien käyttöehdot (PDF, 333.59 kB)Opens in a new window. (in Finnish)

Käyttölupa Suomi.fi-palvelut (PDF, 266.61 kB)Opens in a new window. (in Finnish)

3. Start the deployment of the Suomi.fi Data Exchange Layer

The register is connected to the Data Exchange Layer through a Security Server, so you should start the deployment of the Data Exchange Layer as well.

4. Schedule and plan

Specify the persons responsible for the deployment of the Web Service and the register that will be connected to the Web Service. Describe the use case at a general level and plan the deployment schedule. Fill in the basic information for reporting the information required for deploying the Web Service: Suomi.fi-verkkopalvelu: Rekisteritiedot (DOCX, 306.62 kB)Opens in a new window. (in Finnish)

Submit the filled-in basic information form by email to verkkopalvelu-kayttoonotot@dvv.fi.

5. Submit the data model for your register to the Digital and Population Data Services Agency

Submit the information provided by your register to the Digital and Population Data Services Agency in Finnish, Swedish and English. For more detailed instructions on the data model, see the example.

6. Join the Data Exchange Layer

At this point, your Security Server gets connected to the Data Exchange Layer. At the same time, the necessary interfaces are connected to it, and the data contained in the interfaces is given access to the Web Service.

This results in:

• a Data Exchange Layer Security Server
• a connection to the Data Exchange Layer
• a SOAP/XML interface or REST interface to the register of your organisation that is being connected
• a Handlebars template (Mustache compatible) for retrieving data to the Web Service.

Also learn more about interface queries.

7. Test your service and have it approved

Testing consists of the following steps:

• test cases: incident management, data validation, definition of test personal identity codes
• service testing against test cases
• error corrections.

Always use a test environment to test a service that is to be connected. The service has to pass the tests before the register can be transferred to the production environment. Instructions for testing are on the register test page.

Finalise the documentation and have your service approved by the Digital and Population Data Services Agency.

8. Deployment to production

The Digital and Population Data Services Agency and the technical expert of your organisation coordinate the deployment of the service in the production environment. Inform the customers and stakeholders of your organisation that your register data is now accessible through the Suomi.fi Web Service. Also arrange any necessary customer service.