About the Klipfolio category

o.plokha · May 6, 2024, 10:34am

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

Extra information

System documentation: Klipfolio API Reference

Connector package documentation

1. Setting up HTTP Client Klipfolio

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Klipfolio HTTP Client as PlatForm and click next step
Fill in the Base URI, and API Key.
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 Klipfolio

2.1 Steps

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

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “Groups - Get the details for the specific group” entity.

From the end point, we can see that we need to set “id” as parameters. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to Klipfolio with the URL /groups/6c8e67da624da053998c7a907d587a81

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 Klipfolio.

3. Publishing Entity to Klipfolio

3.1 Steps

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

Entity

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

For example, we want to delete a group. Please select “Delete” as the Method and “Groups - Delete a group” as the entity of the publisher.

From the end point, we can see that we need to set “id” as parameters. That is why we set the “id” inside the path key in the data.

Alumio will send an API request to Klipfolio with URL /groups/6c8e67da624da053998c7a907d587a81

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.