Request a permission to use a service in the API Catalogue

This article explains how to apply for a permit for an individual service in the API Catalogue.

Take the following matters into consideration:

• You can apply for a permit to use the subsystem and services in the API Catalogue if the service provider has enabled the function. Once enabled by the service provider, the API Catalogue displays a separate section to logged-in users on the subsystem’s page, Request permission to use subsystem.
• You can also apply for a use permit as an intermediary acting on behalf of another organisation. If you are applying for a permit on behalf of another organisation, you need separate identifiers for the Test API Catalogue and the API Catalogue, and also access to the organisation in question in both the Test API Catalogue and the API Catalogue.
• You may need a data permit or equivalent before applying for a permit in the API Catalogue. The organisation usually mentions such limitations in the subsystem’s description. If you are unsure of the limitations of using the subsystem, contact the organisation that owns the subsystem.

Use permit application options

The subsystem use permit application is one of the following options:

• Electronic form: The organisation may have a predefined permit application of the API Catalogue you can use to apply for a permit. You can fill in the permit application using the Request permission to use subsystem button. Your use permit application will be forwarded to the organisation to whose subsystem you have requested access.
• PDF form: The organisation may use its own PDF permit application. You can download the permit application from the API Catalogue through the Download use permit application button. The organisation’s email address is mentioned in connection with the permit application to which you should send the completed use permit application.
• Link to the organisation’s website: There are other ways to create the permit application too, in which case the API Catalogue contains a button Request permission on organisation’s website. This button directs you to the organisation website, where you can find additional information on how to apply for a permit.

Filling in a predefined use permit application

The electronic form requires the following information:

• Information on the applicant: The contact information has been pre-completed on the basis of the information given in connection with the introduction of the Data Exchange Layer. You can edit the pre-filled details if required. By selecting Applying for a use permit on behalf of another organisation, you must also fill in the details of the organisation using the service.
• Information about the security server and subsystem: The IP address of the Security Server and the subsystem data for which you are applying for a permit and firewall opening.
• Details of the service to be deployed: Select the subsystem services (interfaces) for which you are applying for a permit. Explain the purpose for which you are requesting a permit and the date when will you need the subsystem.

Own service licence applications

If you have applied for the subsystem permit using an electronic form, you can view the application in the API Catalogue under Summary > Use permit applications. If you have filled in a permit application in another way, it will not be visible in the API Catalogue.

The organisation from which you are applying for a permit will inform you of the approved permit. For additional information on your permit requests, contact the organisation providing the services.

You can read more about service deployment from the Enable the service offered through the Suomi.fi Data Exchange Layer article.