Brightpearl - Gathering API Credentials

In order to enable API Access, the following credentials must be gathered:
  • Datacenter Code
  • Account ID
  • API User Email
  • API User Password

Gathering Datacenter Code

The Datacenter Code is the timezone selected during Brightpearl account creation.

Gathering Account ID

The Account ID is available in Brightpearl account settings.

Creating User New User in Brightpearl 

It is recommended that a separate user is created specifically for API communications:
  1. Login to the Brightpearl application

  2. Click Setup > Add new staff member

  3. Enter the required information to create the new user then click the Save button

  4. Click Staff / Users > List staff. For the newly created user, click the Password link to set the API User Password.


  5. Retain the User Email and Password. On the List staff screen, ensure the newly created user has a green check under the API column, if it does not click the red X once.