API Configuration

Authorization

Authorization for Bright API is currently done through a pre-generated JSON Web Token. Bright Energy will generate the tokens 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

Currently configured variables from your account:

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