Go directly to contents.
Best practices for developers
API design in public administration
  1. Guide's start page
  2. Before procurement
  3. During the development process
  4. When a program or application has been completed
    1. Publish the data model and source code openly
    2. Support software developers
    3. Create a high-quality deployment process
    4. Publish the life cycle and create versioning
    5. Support experiments and use
    6. Plan retirement
  5. Glossary

When a program or application has been completed

Publish the data model and source code openly

Facilitate ecosystem development by publishing the source code, data model and documentation of the implementation openly.

Support software developers

When you invest in the developer experience, you support the use of the API.

Create a high-quality deployment process

Clearly define and communicate about the API's service-level agreement. Create a fast deployment process that is automated as far as possible.

Publish the life cycle and create versioning

Communicate about the planned life cycle of the API and introduce high-quality versioning.

Support experiments and use

When you create an open test version of the API, you facilitate its deployment.

Plan retirement

Plan for the end of the API's life cycle. Consider the stakeholders when retiring an API.

Glossary