This documentation will support you (the Developer) during the Integration Steps and educate you on how Bright Kit and Bright API are used to provide an excellent User experience.

🔰 Guides

What you're looking at right now is the first page of our Guides section. Here we describe everything you need to know to Go Live with our white label solution. If you find something confusing or think anything is missing please make a Suggested Edit on that page.

We will clarify with an edit as soon as possible.

🚦Interactive API experience

We have connected our OpenAPI specification files to the API Reference section for you to be able to:

• Demo Endpoints through examples or add your authorization header to see responses in real time. Useful for learning about different response types and seeing if your variables are correctly formatted.
• Reference each endpoint as needed during the integration process. Learn which endpoints are interdependent and what order they should be built.
• View Request Logs: See your request history made right here in the hub.

🏗️ Changelog

View updates made to our specification files and the developer hub.

• Specification file changes are almost always non-destructive. This means we are not breaking any current integration built but adding to what already exists. Breaking changes will be avoided at all possible by versioning the Kit and API or sunsetting unused endpoints with plenty of notice for our customers.
• Documentation changes are easier to manage and we will test redirects to make sure internal/external links aren't broken after an update.

🤳 Support

Bright Energy has done our best to make your development process self-service and complete.

If you get stuck, shoot us an email and we will get back to you as soon as possible.