Reminder: Suomi.fi Messages migrates to REST API

Suomi.fi Messages is migrating to the REST API. Through this new API, it is possible to implement functionalities that were previously in Suomi.fi Messages as features of different APIs.

With the REST API, organisations that use Suomi.fi Messages no longer have to compare different APIs and their features – all features are now available through a single API. We have also improved the functionalities of the service: new features have been introduced and existing features have been updated to better meet the needs of the users.

The Digital and Population Data Services Agency has set a schedule for discontinuing the old connections. The REST API does not influence the old APIs, and they will continue to be temporarily available alongside the new API. However, all new activations of Suomi.fi Messages will only be carried out through the REST API from now on.

Migration schedule for the REST API:

Starting 1 January 2025: New connections will no longer be made to old APIs, e.g. new email connections will no longer open.

Starting 1 January 2026: No more services will be added to old connections (especially software solutions offered by ICT service providers)

1 January 2027: The old APIs will be shut down. Each organisation using Suomi.fi Messages must be using the new REST interface.

What does this mean for organisations that already use Suomi.fi Messages?

The migration requires organisations that use Suomi.fi Messages with WS, SFTP or SMTP APIs to take measures.

These measures depend on:

• which API they are using,
• what the API has been used for, and
• how the API was implemented.

We have published a blog post to support organisations that use Suomi.fi Messages and intermediaries that have integrated Messages into their software services. In the post, we explain what the migration to REST means for users of the other APIs and what they need to take into account in connection with the REST migration.

In summary:

What does the migration mean for organisations that use WS and SFTP APIs?

• Find out if your organisation is using the WS or SFTP API.
• Contact your ICT expert or software supplier to find out if they have planned to support REST for the desired system and on what schedule? Also ask which functionalities will be supported in the future.
• Schedule the migration well in advance.
• Review the new functionalities offered by the REST API and redesign your customer process. Make sure that you communicate well and train your customer service personnel.
• If you will be using Suomi.fi Messages in the same services as before, you do not need to apply for a new licence.
• Consider whether your organisation has other services that could also benefit from the activation of Suomi.fi Messages.

What does the migration mean for organisations that use the SMTP API?

If your organisation has used the SMTP API (= email connection), it is being discontinued in Suomi.fi Messages. Suomi.fi Messages will also not provide a user interface intended for customer organisations to the service.

• Review your usage of the SMTP API.
• Assess what you want to replace that functionality with.

The Digital and Population Data Services Agency has compiled some examples of case management systems and other standard applications with Suomi.fi Messages integration on the Standard Software and Messages deployment page (in Finnish) of the instructions for Suomi.fi Messages. The page also contains tips for taking the requirements of Suomi.fi Messages into account in connection with competitive tendering for systems.

Instructions for migration to the REST API

Migration from the old Suomi.fi Messages APIs (WS, SFTP) to the new REST API is largely similar to the instructions for a new REST deployment. However, there are a few key differences.

1. Submit the service information form and IP addresses 

Use the service information form to indicate the system in question. Please note that if you use Suomi.fi Messages through standard software provided by an ICT supplier, the supplier may have already opened the necessary ports for your IP address. Check with your software provider (which acts as the Suomi.fi Messages intermediary). Complete and submit the service information form and the Digital and Population Data Services Agency will open the necessary ports for your IP address. 

2. The Digital and Population Data Services Agency will provide you with the necessary IDs 

You will be sent an email with your organisation’s system ID (systemId), service ID (serviceId) and dummy personal ID codes for testing 

In an encrypted e-mail, you will receive: 

• a temporary password for the test environment, which you must change before use.
• after testing, a temporary password for the production environment, which you must change before use. 

Instructions on how to change your password are available in the technical deployment instructions. 

3. Implement the changes 

Pay particular attention to new instructions and functionalities. Carefully read the service description and the stages of administrative deployment. 

4. Test the connection 

Test the connection according to the testing instructions.

5. Submit the Deployment checklist

Make sure that your organisation has taken all relevant factors into account by filling in the Deployment checklist.

Please note that in REST migration, you fill in the checklist in as applicable. For example, you do not need to fill in "Process changes and communications" if the REST migration is just a technical change.

Submit the completed checklist to the Digital and Population Data Services Agency and indicate the date on which you intend to transfer to production. Send the checklist by e-mail to viestit-kayttoonotot@dvv.fi. Use “REST migration: starting production use” as the subject line.

Once the Digital and Population Data Services Agency has verified your checklist, we will provide you with credentials for the production environment, which will enable production use of Suomi.fi Messages. 

6. Migrate to the REST interface

Agree on when to close the old API connection with the Digital and Population Data Services Agency:  viestit-kayttoonotot@dvv.fi

7. Maintain the connection

Your organisation must also maintain of the connection for its entire life cycle. Read the administrative and technical maintenance instructions on the Maintenance page.

Contact information

Deployment Support

viestit-kayttoonotot@dvv.fi