API Catalogue

It is important that the users of the API Catalogue can easily see which subsystems contain interface services that can be utilised through the Suomi.fi Data Exchange Layer and which ones can not.

Describe your organisation’s subsystems that utilise services through the Data Exchange Layer in a way that the description clearly states that the subsystem does not provide services.

You can use the following sentence: "This subsystem does not provide services; instead, it only utilises the information obtained via the Suomi.fi Data Exchange Layer."

Services can be implemented by contacting the service provider and agreeing on the use of the service with them. Please note that the implement processes of the services are all different and require different agreements and permits. You can find all the organisations connected to the Suomi.fi Data Exchange Layer's production environment and their service descriptions in the API catalogueOpens in a new window..

Read more from the support article on the implementation of services provided through the Data Exchange Layer. 

No, it is not possible. Information about an organisation’s access rights is visible only to the security servers that consume or provide that particular service. The Data Exchange Layer's central server does not have access to this information.

If your service does not appear at all in the API Catalogue on the subsystem page, you should check the memory settings of the security server's Proxy and Signer processes. For instructions on how to check and change memory settings, see the support article on the topic. 

Services are shown as unknown in the API Catalogue if they are missing technical service descriptions from the Security Server WebUI. Without a service description, API Catalogue cannot recognise whether the service is a REST or SOAP service.

Usually, an unknown service is a REST service that has been added to the Data Exchange Layer using the REST API Base Path. API Catalogue cannot recognise these types of services as REST services. The technical description for a REST service has to be in OpenAPI 3 format for it to show automatically in the API Catalogue.

We recommend adding REST services to the Data Exchange Layer by using OpenAPI 3 Description path in the Security Server WebUI. This way the API Catalogue can recognise the service and show the technical interface description automatically. Even if you cannot add the technical description in OpenAPI 3 format, we still recommend adding a description, for example as an attachment.

Sometimes, SOAP service’s WSDL-description can disappear. In this case, the service also shows as unknown in the API Catalogue.

Read more about the technical description of the services in the support article. 

You can gain access to the API Catalogue by contacting the Data Exchange Layer’s support address palveluvayla@palveluvayla.fi.