Suomi.fi for Service Developers
Go directly to contents.
Best practices for developers
API design in public administration

During the development process

Use agile methods to build APIs: develop them in small steps and start from the most important one.

Design an open data model as required by regulation and the operating environment. Also think of international interoperability in the model design.

Develop draft APIs based on the data model and following the API First model. Co-design the drafts with relevant stakeholders.

Apply an architectural style diversely and with customer orientation, structuring value.

Focus on customer-oriented design and take API users' perspectives into account.

Include automated unit testing and high-quality integration testing as built-in features in the API, and plan for comprehensive performance testing.

Protect any personal data processed through an API. The main goals of information security are for example data confidentiality, integrity and availability.

Glossary