Describing your organisation in the API Catalogue
This instruction describes what information about your organisation it is recommended to include in the API CatalogueOpens in a new window..
The organisation description helps other users of the Suomi.fi Data Exchange Layer identify your organisation and understand what data or services your organisation provides and/or uses through the Data Exchange Layer.
How can I edit my organisation’s information?
You can edit your organisation’s information by managing the organisation. Please note that you must have permission to edit your organization’s information in the API Catalogue. Edit the information as follows:
- Log in to the API Catalogue.
- Go to your organisation's information in the API Catalogue and select Manage.
If you do not have permission to edit your organisation’s information, ask your organisation’s API Catalogue administrator to grant you the necessary permissions. If your organisation does not have anyone with the permissions for editing your organisation’s information, you will have to ask for the necessary permissions and IDs from API Catalogue maintenance at palveluvayla@palveluvayla.fi.
What should be included in the organisation description?
Provide a general overview of your organisation:
- What organisation it is
- Organisation's tasks
You can also briefly describe what kinds of subsystems and services your organisation provides through the Suomi.fi Data Exchange Layer. Your description can also include a link to your organisation’s website.
In the contact details section, you can, for example, add an email address, website address and postal address. You can also provide other information about the organisation, such as the form of business and the organisation's operating language.
The description should also be provided in Swedish and English.
For example, the Digital and Population Data Services Agency’s organisation descriptionOpens in a new window. provides a concise description of the organisation. The description also includes an email address and a link to the agency’s website.
You can further supplement your organisation description in the API Catalogue with information about the types of data your organisation provides through the Data Exchange Layer.
Your organisation should have a logo or image in the API Catalogue, as it makes it easier for other users to identify the organisation. To add an image
- from your workstation, select Upload.
- from a URL, select Link.