What is Bright Kit?

Learn about the purpose of Bright Kit and its core functions.

bright-kit-logo

In order for Bright Energy to access the data for your Users, we need you to build/enable access for us!

We have designed an API specification that your Developer will build to access your Data Layer called Bright Kit. The Kit specification contains different endpoints that allow Bright Energy to authenticate, fetch data and report events.

Why do I need to build this?

There are many technical solutions possible to enable this access. A few examples include: direct database access, access to an existing API or building a direct custom integration.

After years of testing different technical setups with many customers Bright Energy has chosen Bright Kit as the best solution to maintain product integrity and serve our customers most efficiently. Kit ties in directly with Bridge , your dedicated Bright containers and ultimately the user experience in app. Additionally when new features are added Kit is the fastest way to give access to all our customers and let them control when the feature is available for their User base.

Where is data stored?

📘

Bright Energy does store your User data in a database.

To aid in being GDPR compliant, we use a caching setup in your own private deployment. The cache is able to provide a faster UX for your Users, but not all data can be stored in this way. Some endpoints will only display data directly from your Data Layer, like Measurements.

The cache expiry is 24 hours and therefore must be refreshed daily through Data Synchronisation.