# Finding service connector credentials for Brightpearl

## Required credentials

To [add a Patchworks connector](/product-documentation/patchworks-services/service-connectors/adding-a-service-connector.md) for **BrightPearl**, the following details are required for authentication:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required</th><th>Note</th></tr></thead><tbody><tr><td><a href="#base-url">Base URL</a></td><td>true</td><td><p>The Base URL must be entered in the form:</p><pre><code>https://{DATACENTER}.brightpearlconnect.com/public-api/ 
</code></pre><p>...where the <strong>DATACENTER</strong> placeholder element is replaced with your pwn datacenter value. To find this value, see <a href="#base-url">details below.</a> </p></td></tr><tr><td><a href="#account-code">Account Code</a></td><td>true</td><td>Visible having logged into the  BrightPearl dashboard - see <a href="#account-code">details below.</a> </td></tr><tr><td><a href="#name-and-identifier">Name</a></td><td>true</td><td>Generated by creating a <strong>private app</strong> for Patchworks in BrightPearl - see <a href="#name-and-identifier">details below</a>.</td></tr><tr><td><a href="#name-and-identifier">Identifier</a></td><td>true</td><td>Generated by creating a <strong>private app</strong> for Patchworks in BrightPearl - see <a href="#name-and-identifier">details below</a>.</td></tr></tbody></table>

## Obtaining credentials

The credentials listed above are needed so that Patchworks can access the required data in **BrightPearl**. To obtain these details, follow the steps below.

### **Base URL**

**Step 1**\
Copy and paste the URL below into your preferred text editor:

```
https://{DATACENTER}.brightpearlconnect.com/public-api/ 
```

**Step 2**\
In your browser, open the URL that you use to access the **BrightPearl** dashboard.

**Step 3**\
Check the URL in the address bar - you're looking for the first value, immediately before 'brightpearlapp' element - for example:

&#x20;![](/files/iZqV3iZRUIet9FFZRV7C)

**Step 4**\
Copy this value and paste it into the text document you created in step 1, replacing the entire {DATACENTER} element. Taking our example, the finished URL would be:

<figure><img src="/files/WNIWZpLmwSrgMbAJoWCO" alt=""><figcaption></figcaption></figure>

### **Account code**

**Step 1**\
Log into your BrightPearl dashboard.

**Step 2**\
Check the bottom right-hand corner for your **account id** - this is your Patchworks account code. In the example below, ours is set to 'patchworkstest':

<figure><img src="/files/q5ebv00GrqQMvLEiE7WI" alt=""><figcaption></figcaption></figure>

### Name & Identifier

**Step 1**\
Log into your BrightPearl dashboard.

**Step 2**\
Navigate to **app store** > **private app** > **add private app**. A **new private app** form is displayed.

**Step 3**\
Update the **name** and **identifier** fields as appropriate. You can enter whatever you like here, but it's a good idea to use something that identifies this as a Patchworks app - for example:

<figure><img src="/files/t6sT42p7yeusAcRW7hlU" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-systems/supported-service-systems/brightpearl-service-connector/finding-service-connector-credentials-for-brightpearl.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.