With these guidelines, the API Strategy Working Group aims to establish a set of best practices and standards for designing, developing, documenting, and maintaining APIs specific to the Dutch energy sector.

Publications

URI Strategy - Guidelines for the consistent structure of URIs and resource naming in RESTful APIs
API Design Rules - Guidelines for creating clear, consistent, and developer-friendly APIs
Event Data Specification - Specification of Event Metadata

For approval

Note: this is a draft! Event Data Specification - Specification of Event Metadata

Note: this is a draft! API Design Rules - Update of appendix HTTP operation usage.

How to read the guidelines

Guidelines for architecture and design of the integration are not given here. However, it is advised to first determine the overall interaction between systems.

When starting to develop an API for the Dutch energy sector, first determine which resource (and operations on this resource) you need to disclose. The URI Strategy can be a helpful resource for your design.

When setting up a REST/JSON-based API specification (OAS spec), the API Design Rules are here to guide and direct you.

If you are defining messaging, the Event Data Specification should be used to aid you in the metadata of the event. For the actual data payload you can use the aforementioned rules.

Suggestions

If you see a typo or like to suggest an improvements, please raise a ticket. Please include the URL of the page on which you comment on (as deep link).

Publications are made available to the public under the following LICENCE.