About the Channable category

anon99371720 · September 21, 2022, 11:08am

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

Extra information

System documentation: Channable API Reference

Connector package documentation

1. Setting up HTTP Client Channable

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select the Channable Client as the HTTP Client.
Fill in the Base URI, and Bearer Token according to your Channable account.
For more information, see Channable Getting Started
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 Channable

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select Channable Subscriber as the subscriber.
Select the Channable HTTP Client to use.
Fill in the company id and project id.
Select the entity you want to subscribe to from Channable.
Add any request parameters needed to subscribe to the entity. Please refer to an example in the General Concept section.
You can optionally add a transformer to transform the request parameters before making a request to Channable.

2.2 General Concept

We follow Channable documentation for building this connector, which means you can easily use the connector based on the Channable API Reference.

Entity

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

Request Parameters

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

Please look at the example below on how to fill the Request Parameters field when subscribing to the Channels For Transporter entity. We can see in the documentation that there are some parameter values in the path URL such as transporter_code.

We set the Request Parameter as an example below:

“Path” is the path parameter of the url. For example the {id}.
“Query” is a defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

Alumio will then send it to Channable as
/v1/transporters/transporter/DHL

Input Transformer

Any transformers that are set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as the query parameters of an entity.

HTTP Client

The HTTP Client configuration you will use to access Channable.

3. Publishing Entity to Channable

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select the Channable Publisher as the publisher.
Select the HTTP Client to use.
Select the Method that you want the publisher to perform with the data.
Select the Channable entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
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.

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 POST method on submitting data to Channable.

Entity

We support publishing to most Channable endpoints.
Please refer to Channable API Reference page.
Based on the documentation, some endpoints may need one or more path parameters.

For example, we want to update return status. Please select “POST” as the method and “Update Return Status” as the entity of the publisher.

The documentation says that we need “return_id”, “company_id”, and “project_id” as path parameters. In that case, you need to provide “return_id”, “company_id”, and “project_id” key into the path key in the data, either as an output from Routes or output from Transformers in Outgoing Configuration. And, you can put the payload you want to send to Channable into the payload key in the data. Here is an example of the required data.

Alumio will send an API request to Channable with the URL
/v1/companies/29370/projects/84767/returns/1/status
and the body will be like this.

Path is the path parameter of the url. For example the {id}.
Query is a 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.