Variables

As found in the Postman collection, the following variables need to be designated and configured from the Organisation for Bright Energy to make requests:

• kitEnvironment is the name of the environment Bright Energy will target when making requests.
  • staging
  • production
• kitDomain is the name of the domain you have deployed the Bright Kit implementation to.
• kitBasePath is the version of the Bright Kit being targeted.
  • v1

The baseUrl structure:

https://{{kitEnvironment}}.{{kitDomain}}/{{kitBasePath}}

An example fullUrl structure would be:

https://{{kitEnvironment}}.{{kitDomain}}/{{kitBasePath}}/accounts/:accountId/services/:serviceId/events

HTTP Response Status Codes

Implemented endpoints shall return the specified response status codes.
Any endpoint that is not implemented shall return the code 501 Not Implemented.