Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Brightpearl API Reference
Connector package documentation
**Brightpearl**Setting up HTTP Client Brightpearl
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Brightpearl HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, Application Reference and Token.
- Save the Client for use later.
Subscribing to Entities from Brightpearl
Steps
- Go to Connections → Incoming and create a new incoming configuration and select Brightpearl Subscriber as the subscriber.
- Select the entity you want to subscribe from Brightpearl.
- Add any request parameters needed to subscribe to the entity (optional).
- You can optionally add a transformer to transform the request parameters into something you need.
- Select the Brightpearl HTTP Client to use.
General Concept
We follow Brightpearl documentation on building this connector so you can easily use the connector based on Brightpearl API Reference.
Entity
It’s the entity you want to subscribe from Brightpearl. Please refer to the entities in Management APIs from Brightpearl API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Brightpearl API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Product entity
That’s why we need to define the ID-SET property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Product.
/product-service/product/126274
Input Transformer
Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Brightpearl.
Publishing Entity to Brightpearl
Steps
- Go to Connections → Outgoing, create a new outgoing configuration, and select Brightpearl Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the Brightpearl entity you want the data to be published.
- You can optionally add any query parameters to the request.
- You can also optionally add any transformers to transform the data into anything you need before submitting it to Brightpearl.
- Select the HTTP Client to use.
General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.
Action
Currently, we support Post (HTTP POST method), Put (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method).
Entity
We support publishing to most Brightpearl endpoints. Please refer to the entities in Management APIs from the Brightpearl API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create Product. Please select “Post” as the action and “Product” as the entity of the publisher.
You can put the payload you want to send to Brightpearl into the payload property in the data.
Alumio will send an API request to Brightpearl with URL /product-service/product
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Brightpearl.