3. Join the test environment
After this section you have
- submitted a user permit application for the test environment
- described your organisation and services to the API Catalogue's test environment
Joining the test environment consists of sending a user permit application and of a technical integration process, which your organisation can outsource to the technical solution provider of its choice. You must join the Data Exchange Layer test environment before you can go to the production environment.
This section describes the steps 1 and 9 which the administrative person is responsible for when joining the test environment. The technical joining process (phases 2-8) will be performed either by a technical solution provider or by your own organisation, depending on whether or not you have outsourced the security server solution. The technical joining process is described more closely in the technical deployment section.
- Submit a user permit application for the test environment.
- Open firewalls according to the instructions that you previously received.
- Install the security server software. The instructions for installing the security server depend on your server’s operating system. After this, the host server will become the security server, which you can use to connect your information system to the Data Exchange Layer.
- Configure the security server. The security server can be configured programmatically or manually.
- Add a subsystem to the security server. The subsystem will function as an interface to the Data Exchange Layer for retrieving and providing information.
- Connect the information system to the security server. In this way the information is transferred from your information systems to the Data Exchange Layer and vice versa.
- If you intend to provide services to other organisations on the Data Exchange Layer, add your service to the security server. The services will be added to one of the previously added subsystems.
- Deploy the adapter service if necessary. You will need an adapter service if you provide SOAP services through the Data Exchange Layer that are not tailored to the requirements of the Data Exchange Layer.
- Describe your services in the API Catalogue's test environment if you offer services in the Data Exchange Layer.
1. Submit a user permit application for the test environment
The use of Suomi.fi Data Exchange Layer requires applying a separate user permit application for both the test and production environment separately. Below you will find instructions for applying for a user permit.
1. Check from the technical side that the following matters are done correctly:
- The security server has been named according to instructions
- An operating system is installed on the host server of the security server
2. Make sure you have the following information for the user permit application:
- contact details of the administrative and technical contact persons in charge: name, e-mail address (please note, that this should be a general and static e-mail address for the organisation)
- Name and Business ID of the organisation using the Data Exchange Layer
- organisations role in the Data Exchange Layer (service provider/consumer)
- information about the security server from the technical administrator: type of security server (own, shared or outsourced), security servers FQDN and public IPv4-address
- the right to accept the terms and conditions of use of the Data Exchange Layer
3. Register to the Suomi.fi Service Management if you have not used the service before
- As you register you must have an authority to sign. Read more in the instructions about registration to Suomi.fi Service Management.
4. Send an electronic application to the Digital and Population Data Services AgencyOpens in a new window.. Also read the instructions on completing the user permit application.
Once your user permit application has been approved, your organisation's technical contact person will receive an email with the installation instructions for joining the test environment.
9. Describe your services in the API Catalogue's test environment if you offer services in the Data Exchange Layer
Finally, describe the details of your organisation and services in the API Catalogue's test environmentOpens in a new window. in Finnish and Swedish. In the Test API Catalogue, ensure that your subsystem shows correctly and familiarise yourself with the services available. You will receive the credentials for the Test API Catalogue when you have finished joining the test environment and your services are available in the Data Exchange Layer's test environment. Read more about the API Catalogue environments and refer to the API Catalogue instructionsOpens in a new window..
Describe your organisation briefly with the following general information:
- Name of the organisation
- Organisation's tasks
Read also the instructions on describing the organisation's information.
If your organisation provides services, describe at least the following information about your service:
- What data can be accessed through the service
- What kinds of prerequisites and limitations apply to the use of the service
- How to access the service: implementation process and required user permit applications
When describing the services, you can follow the instructions and make use of the ready list of questions. By answering the questions you can create a comprehensive service description. See also the example of the service description of Suomi.fi e-AuthorizationsOpens in a new window..
When you describe your services carefully in the API Catalogue, it is easier for others to find and use your services. Do not write your description in an overly technical fashion – focus instead on making it as understandable as possible. Write a compact description but remember to mention all the essential details. Note that well-written descriptions can later be copied to the production environment.
Notes on the certificate process
The certificates used in the Data Exchange Layer are now applied for in the Digital and Population Data Services Agency’s (DVV) e-services. The organisation is responsible for the certificate process and for ensuring that a customer account is available in the e-services and that the users required to manage the certificate process have been invited to the account.
The certificate application may be submitted by either a technical or an administrative contact person. The administrative contact person is responsible for ensuring that the technical contact persons have the necessary rights to manage the certificate process.
Read more detailed instructions: