Enabling the use permit application function in the API Catalogue

This article describes how to enable the use permit application feature in the API Catalogue. 

Users who have logged into the API Catalogue can apply for access to the services of a subsystem using the use permit application function. In the API Catalogue, you can only ask for a permit for those subsystems where this feature is enabled. Once enabled, the API Catalogue displays a separate section on the subsystem’s page, Request permission to use subsystem.

Note that in the API Catalogue, you can only view the received use permit applications. You can find the received permit applications on the subsystem’s page under Received use permit applications, if the type of permit application has been selected as the Predefined use permit application in API Catalogue.

Activating a function in the API Catalogue

You must enable your subsystem’s permit application function separately for each subsystem in your organisation, as it is disabled by default. To enable this function in the API Catalogue on your own subsystem’s page, go to Edit > Use permit application settings.

1. Select the type of permit application

You have three options to choose from for the use permit application in the API Catalogue:

Predefined use permit application in API Catalogue

• Electronic form that the use permit applicant fills in the API Catalogue
• Possibility to request additional information as an attachment
• An email will be sent to the email address specified in the API Catalogue regarding the sent use permit application

Organisation’s own downloadable use permit application

• Your organisation’s own PDF form with which to apply for a use permit to the subsystem.
• The applicant must download the form from the API Catalogue and send the completed form to the email address you specified.

Link to the use permit application on the organisation’s own website

• Website URL to access and fill in the application.

2. Fill in the required information

You must fill in the email address to which the completed form will be sent in the API Catalogue’s predefined permit application and the organisation’s own permit application. 

You can also request additional information from the permit applicant using a separate attachment. Please note that you should not ask to provide personal data in the attached files, as the attached files will remain available to the administrators of the API Catalogue and can thus form a personal data file. You should ask to submit any personal data outside the API Catalogue.

3. Describe the permit process

Describe how the permit process progresses with the services you provide. The criteria for granting a permit should be described in the description of either the subsystem or an individual service, depending on the limitations of using the service. Read more about Describing the subsystem and services in the API Catalogue article. Remember to also inform the customer of the approval of the permit.

Review of received use permit applications

In the API Catalogue, you can view received use permit applications if the type of application has been selected as the Predefined use permit application in API Catalogue. You can see the received use permit applications on the subsystem’s page in the Received use permit applications section. If you have chosen another type of application for a use permit than the Predefined use permit application in API Catalogue, the received use permit applications will not be visible in the API Catalogue.

Do you want to apply for a permit for an individual service in the API Catalogue?

Follow the instructions in the article Request a permission to use a service in the API Catalogue.