About the Cloudsuite category

anon99371720 · September 21, 2022, 11:03am

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

Extra information

System documentation: CloudSuite API Reference

Connector package documentation

1. Setting up HTTP Client CloudSuite

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select CloudSuite HTTP Client as the HTTP Client.
Fill in the Base URI and Authentication Token
(For more information, see CloudSuite 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 CloudSuite

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select CloudSuite Subscriber as the subscriber.
Select the entity you want to subscribe to from CloudSuite.
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 CloudSuite.
Select the CloudSuite HTTP Client to use.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “Address” entity.

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

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

Alumio will then make a request to CloudSuite with the URL /address/403035324637

HTTP Client

The HTTP Client configuration you will use to access CloudSuite.

3. Publishing Entity to CloudSuite

3.1 Steps

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

Entity

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

For example, we want to use “Delete an Asset”. Please select “Delete” as the Action and “Asset” as the entity of the publisher.

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

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.

Alumio will send an API request to CloudSuite with URL /asset/123