General technical overview
Technical overview of the Registers section of the Suomi.fi Web Service
Through the Suomi.fi Data Exchange Layer, the Registers section of the Suomi.fi Web Service provides end users with personal data or business information from several data resources connected to the service. Connecting a register to the Web Service requires deploying the Suomi.fi Data Exchange Layer and creating a SOAP or REST interface in the data repository that is to be connected. Read more about the Data Exchange Layer and its deployment.
The data displayed in the Suomi.fi Web Service is a summary of key information selected by the client organisation from its registers. The data will not be saved and will only be disclosed to the end user in question. The online service calls the connected service by sending a message call that contains the personal identity code of the identified person and the desired language version (Finnish, Swedish or English). The call is sent out from the Web Service when the end user has used the Your data section to select which register data they want to view. The connected service is then required to return a message that contains all the data to be displayed in the desired language. Read more about generating a SOAP/XML message on the Interface queries in registers page.
The data communication of registers runs through the Suomi.fi Data Exchange Layer whose traffic travels across the public internet between Security Servers. Data is encrypted during data transfer using the TLS (SSL) encryption protocol, and all data is signed with certificates. The implementation of the X-Road solution Security Servers interface uses the XML-based Simple Object Access Protocol (SOAP) data traffic protocol. Using REST architecture is also possible, but ask the Digital and Population Data Services Agency about this option before further planning your deployment.
In SOAP implementations, data is displayed in the Web Service by converting the SOAP/XML message to JSON and extracting the fields to be displayed with a Handlebars template. A presentation template of the Web Service is used to display the data. When connecting, you have to provide the necessary support links and instructions as well as an icon for your service. Read more about the descriptive data of a register that will be added to the Web Service on page Register description data.
Testing the connection requires the client to have their own test environment and test material and a connection to the test environment. The Digital and Population Data Services Agency performs test searches in the client’s test environment. The final approval testing in the production environment is done together by the organisation connecting to the service and the Digital and Population Data Services Agency, and after the approval, retrieved data from the connected service will be in the Registers section of the Suomi.fi Web Service.