Brightpearl + nShift

Integration documentation and guides

Getting Started · 2

Getting Started

Start with credentials, setup steps, and the key guides for this pair.

oauth2 · The client credentials stay valid until rotated or revoked. OAuth access tokens are short-lived and generated from these credentials.

10-15 minutes

1
Confirm the Brightpearl account context
Identify the correct Brightpearl account code and environment before starting authorization.
2
Use the agreed Brightpearl app setup
Have Junipeer or the app owner confirm the Brightpearl app/client that should be used for the integration.
3
Authorize the integration
Complete the Brightpearl authorization flow for the correct merchant account and environment.
4
Save the account-specific identifiers
Keep any Brightpearl account code, app reference, or related identifiers required by the integration.
5
Finish the setup in Junipeer
Enter the agreed Brightpearl values in Junipeer and verify the connection.

basic_auth · Until disabled, replaced, or deleted

10 minutes

1
Log in to nShift Delivery
Open nShift Delivery and sign in with the account that should manage the API key.
2
Open API keys
Go to Maintenance → API keys.
3
Create a new key
Click New API key, keep Status as Enabled, and set Type to Web Services (REST).
4
Enter the key details
Add a Note, optionally restrict valid IP addresses, enter the correct Developer ID, and choose a Profile if the key should be profile-specific.
5
Save and copy the generated values
When you save, nShift generates an ID, a Secret ID, and a combined ID. Use the ID and Secret ID to authenticate against the REST API framework.
6
Paste the credentials into Junipeer
Enter the API key ID, Secret ID, and Developer ID in Junipeer if those fields are requested by the connection setup.