Getting Started

After your company has signed a contract with Bright Energy, your Customer Success Manager will request the contact information of the Developer(s) who will manage the integration to Bright API. We require the full name and email address of each individual working on the integration for access to customised documentation and Bridge.

Authorization

Authorization for Bright API is currently done through a pre-generated JSON Web Token. Bright Energy will generate your token during onboarding once your access to Bright API is enabled. Treat these tokens similar to an API key as they are secret parameters that are environment specific.

Contact us if you need a new token generated if you suspect your token has been compromised.

Variables

As found in the Postman collection, the following variables are configured from Bright Energy to allow the Organisation to make requests:

• organisation is the name of the subdomain deployed for processing your Bright API requests.
• environment is the name of the environment you are using to make requests.
  • staging
  • production
• brightAPIbasePath is the version of the Bright API you are using.
  • v3

The baseUrl structure:

https://{{organisation}}.{{environment}}.getbright.se/{{brightAPIbasePath}}

An example fullUrl structure would be:

https\://{{organisation}}.{{environment}}.getbright.se/{{brightAPIbasePath}}/account/accounts/sync