CKWOpenEnergyBackend

OpenEnergy Backend API

Introduction

The OpenEnergy API enables CKW customers with smart meters installed at their homes to access their energy consumption and production data. By utilizing this API, customers can conveniently retrieve their energy metrics through various means, such as the CKW web portal or an Android/iOS app. For detailed information about data access, please visit the CKW Website. This API is designed to make meter data easily accessible for integration into websites and applications.

There are two apis to consume Smartmeter data but fulfill different use cases. First use case is, when data is requested directly by the client. In the second use case the data is consumed by a backend from the application. Whenever possible the data should be consumed directly from the client.

In both cases CKW Single Sign On is used for user authentication. The Main difference between the apis is in the authentication on the api. When the api is called directly from the client, the jwt token is used for authentication on the api. For use cases that use a backend specific app credentials will be generated, since the jwt token is only available in the client.

Availability of Data

While CKW offers its own dedicated app for accessing meter data, the API is open to any app that supports CKW Single Sign On. This means that customers have the flexibility to choose third-party apps or extract their data through the API for seamless integration into other systems.

API

Endpoints

The api provides two main endpoints one for core data and another for meter data. For detailed information about each endpoint, please refer to the specification.

Versioning

Versioning in the api is archieved with the major version in the endpoint url. Breaking changes as removing or renaming fields will be done in a new major version. Completely new fields might also be added in the same major version.

Rate Limiting

The API implements rate limiting per user. The api exposes rate limiting headers, these start with 'x-ratelimit'. With these headers the app knows how many requests in a given time might still be sent. More information about the headers can be found in the speficiation section.

Support

If you need support, please send us a mail to openenergy@ckw.ch