About the Vend category

Roland · September 21, 2022, 10:00am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: VendHQ API Reference

Connector package documentation

1. Setting up HTTP Client VendHQ

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “VendHQ HTTP Client” as the HTTP Client.
Fill in the Base URI and Bearer Token.
(For more information, see VendHQ Authentication Reference)
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from VendHQ

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “VendHQ Subscriber” as the subscriber.
Select the VendHQ HTTP Client to use.
Select the entity you want to subscribe to from VendHQ.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from VendHQ.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow VendHQ documentation on building this connector, so you can easily use the connector based on VendHQ API Reference.

HTTP Client

The HTTP Client configuration you will use to access VendHQ.

Entity

The entity you want to subscribe to VendHQ. Please refer to the entities from VendHQ API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the VendHQ API Reference .

Please look at the example below on how to fill path field when subscribing “Get a single brand” entity.

Based on the documentation, we can see that the end point require “brand_id” as a parameter. That is why we set the “brand_id” inside the path key in the Request Parameters.

Alumio will then make a request to VendHQ with the URL /brands/123

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.

3. Publishing Entity to VendHQ

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “VendHQ Publisher” as the publisher.
Select the Action that you want the publisher to perform with the data.
Select the VendHQ 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.

Action

Currently, we support Create (HTTP POST method), Update (HTTP PUT method) and Delete (HTTP DELETE method) on submitting data to VendHQ.

Entity

We support publishing to most VendHQ endpoints.
Please refer to VendHQ API Reference page.

For example, we want to add a new product. Please select “Create” as the Action and “Create brand” as the entity of the publisher.

Based on the documentation, it requires a “BODY PARAMS”. That is why we set the “BODY PARAMS” inside the payload key in the data.

Alumio will send an API request to VendHQ with URL /brands

Another example is when we want to delete a product by id. Please select “Delete” as the Action and “Delete a serial number” as the entity of the publisher.

Based on the documentation, we can see that the end point require “serialnumber_id” as a parameter. That is why we set the “serialnumber_id” inside the path key in the Request Parameters.

Alumio will then make a request to VendHQ with the URL /serialnumbers/1506951202871443456

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.