Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Picqer API Reference
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Picqer
- 1.1 Steps
- 2. Subscribing to entities from Picqer
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to Picqer
- 3.1 Steps
- 3.2 General concept
1. Setting up HTTP Client Picqer
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
- Select Picqer HTTP Client as PlatForm and click next step
- Fill in the Base URI and API Keys.
- You can optionally enable logging of request to get the log of the authentication.
- Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.
2. Subscribing to Entities from Picqer
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select “Picqer Subscriber” as the subscriber.
- Select the entity you want to subscribe to from Picqer.
- Add any request parameters needed to subscribe to the entity.
- Select the Picqer HTTP Client to use.
- You can optionally add a transformer to transform the request parameters into something you will request from Picqer.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
2.2 General Concept
We follow Picqer documentation on building this connector, so you can easily use the connector based on Picqer API Reference.
Entity
The entity you want to subscribe to Picqer. Please refer to the entities from Picqer API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Picqer API Reference.
Please look at the example below on how to fill path field when we want retrieve details of a client by subscribing “Get single customer” entity.
From the end point, we can see that we need to set the customer ID as parameters. That is why we set the “idcustomer” inside the path key in the Request Parameters.
Alumio will then make a request to Picqer with the URL /api/v1/customers/89338142
- Path is the path parameter of the url. For example the {id}.
- Query is defined set of parameters attached to the end of a url.
Example:www.url.com?type=true&start=0
HTTP Client
The HTTP Client configuration you will use to access Picqer.
3. Publishing Entity to Picqer
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select “Picqer Publisher” as the publisher.
- Select the Method that you want the publisher to perform with the data.
- Select the Picqer entity you want the data to be published to.
- You can optionally add any query data to the request on the key query.
- You can optionally add any payload data to the request on the key payload.
- Select the HTTP Client to use.
3.2 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.
Method
Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to Picqer.
Entity
We support publishing to most Picqer endpoints.
Please refer to Picqer API Reference page.
For example, we want to create a user. Please select “Put” as the Method and “Update customer”.
From the documentation, we can see that we need to set a path for customer ID and a body parameter. That is why we set the path “idcustomer” in the path in the data and body parameters inside the payload key in the data.
Alumio will send an API request to Picqer with URL /api/v1/customers/89338142
- Path is the path parameter of the url. For example the {id}.
- Query is defined set of parameters attached to the end of a url.
Example:www.url.com?type=true&start=0 - Payload is the data contained within a request.
HTTP Client
The HTTP Client configuration you will use to access Picqer.