Testing instructions

The sending of a message consists of two phases. First, add any attachments to the message using the attachments endpoint. You can then send the electronic message either from the multi-channel messages endpoint or from the messages/electronic endpoint, which is reserved for sending electronic messages. The identifier of the file to be attached is entered as part of the query message of the message that will be sent.

If you use the multichannel messages endpoint to send the message, an end user who receives messages electronically must be selected as the recipient. You should consequently use the test personal identity code you received and the electronic mailbox you activated for testing purposes.

Checking a notification of a message

Check what the notification of a new message concerning the message you have sent looks like from the end user’s point of view. The notification is sent to the email address that you set for the electronic mailbox when you activated it. You can also check or change the email address in the test environment of Suomi.fi Web Service, in the Settings of Suomi.fi Messages.

It is particularly important to check the formulation of the notification if you have customised its content.

If you do not read the message you sent to the test environment within one hour, a notification of an unread message will be sent to your email address. This enables you to also test receiving a notification for an unread message.

Checking an electronic message

Check what the electronic message you have sent looks like in Suomi.fi Messages from the end user’s point of view in the following way:

1. Log into the test environment of Suomi.fi Web Service. You have received the address of the test environment and the identifiers required for accessing it from the Digital and Population Data Services Agency in connection with the activation process.
2. After logging in, identify yourselves in Suomi.fi Web Service. Select “Test token” as the method of identification and use the personal identity code linked with the mailbox to which you sent the electronic message.
3. Go to the Suomi.fi Messages section in Suomi.fi Web Service.
4. Open the message you sent in the Inbox folder. Please note that after you send the message, it may take a while before you can see the message in the recipient’s electronic mailbox.

The instructions for testing the sending of paper mail and the process that your organisation must follow if you want feedback on your test dispatch from the provider of the TKJ service are described below.

Testing the sending of paper mail

First add the attachment to be sent as paper mail using the attachments endpoint. You can send the message after you have added the attachment. The message delivered in paper mail is sent either form the multichannel messages endpoint or from the paper-mail-without-id endpoint used only for paper mail.

If you use the multichannel messages endpoint to send the message, an end user who receives messages only in paper mail must be selected as the recipient. When testing, use the test personal identity code you received that is linked with the mailbox you have not activated or have inactivated.

Please note that in the QA environment, messages are not by default printed and sent by mail even if they are directed to the paper channel. Track-and-Trace acknowledgements are also not formed of the tests. In the production environment, messages directed to the paper channel are printed and posted by default. Deviations from the above must be agreed with the printing provider.

Checking a message directed to paper mail

If you would like to receive feedback on your test dispatch directed to paper mail, your organisation must send a testing request to the customer service of Posti Messaging Oy. Up-to-date contact details are visible on the website of Posti Messaging Oy. Service requests are recorded in the support service system of Posti Messaging Oy. Set “iPost TKJ testing request” as the subject line and mention the following information in the request:

• the environment used, which in testing is “stage”
• the message identifier (messageId) returned by the endpoint, which is used to form the ZIP file delivered to Posti Messaging Oy and the SenderLetterId field.
• the time of sending the message as accurately as possible
• the client ID you received from Posti Messaging Oy, which you will place, for example, as the value of the “username” key of the "printingAndEnvelopingService” object in the dispatch message.

In addition to the above information, indicate which of the following measures you would like Posti Messaging Oy to perform on the message that will be tested:

• The message will be run for test processing in an environment corresponding to production, but it will not be physically mailed.
• The letter that forms in PDF format and the XML file will be delivered to your organisation by email.

Below is a description of an email requesting testing according to the instructions:

Recipient: [Posti Messaging Oy's email address]
Title: iPost TKJ testing request

Please run the below material in the test environment, without mailing, and return the printout and the XML file to the sender by email.

Environment: stage
Name of dataset: [messageId of the message you have sent].zip
Time sent: [time of sending the message, in format hh.mm, dd.mm.yyyy]
SenderLetterId: [messageId of the message you have sent]
Client ID: [client ID you received from Posti Messaging Oy]

Without the testing request, the test material will remain in the printing provider's environment for 24 hours, after which the material will be removed. Please take this into account when scheduling your testing.

For your organisation to be able to test retrieving the state information of messages, first send a few electronic messages according to the instructions described in the section “Sending messages electronically”.

After sending a few messages, you can retrieve their states using the events endpoint. The retrieval of the states is based on recording keys. Do not provide the recording key with the first retrieval. The service will then return the states of all the messages your organisation has sent to Suomi.fi Messages and the recording key of the state of the message that was updated last. The next time you retrieve the states, you can provide the recording key and then receive only the state updates that have taken place after the previous retrieval.

You can change the state of the electronic message you have sent, for example, by reading it as an end user in Suomi.fi Web Service. To read the message, follow the process described for opening a sent electronic message in the section “Sending a message electronically”.

If your organisation intends to allow end users to initiate communication with you, test searching for messages from end users. First, send at least one message to your organisation in the following way:

1. Log into the test environment of Suomi.fi Web Service. You have received the address of the test environment and the identifiers required for accessing it from the Digital and Population Data Services Agency in connection with the activation process.
2. After logging in, identify yourselves in Suomi.fi Web Service. Select “Test token” as the method of identification and use the personal identity code linked to the mailbox that you have activated.
3. Go to the Suomi.fi Messages section in Suomi.fi Web Service.
4. Send a new message to you organisation using Compose message or reply to a message you have previously sent to the end user by opening the message and clicking the button with the text “Reply to message”. Attach at least one attachment to the message so that you can also test receiving attachments.

When you have sent the message to your organisation as an end user, test searching for it in the following way:

1. Retrieve the identifiers of the messages you have received using the events endpoint.
2. Retrieve the content of the message by entering the message identifier received in step 1 to the messages/{id} endpoint.
3. Retrieve the attachments of the message from the attachments/{id} endpoint by using the identifiers of the message attachments received in step 2.

Using the REST API, your organisation can check if the electronic mailbox of a specific end user is active. The check is carried out using the mailboxes-active endpoint. You can use either of the test personal identity codes you received for testing this.