About the Skunexus category

Alumio_Bot · September 21, 2022, 11:12am

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

Extra information

System documentation: Skunexus API Reference

Connector package documentation

1. Setting up HTTP Client Skunexus

1.1 Steps

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

2.1 Steps

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

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “Find product by ID” entity.

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

Alumio will then make a request to Skunexus with the URL /products/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.

HTTP Client

The HTTP Client configuration you will use to access Skunexus.

3. Publishing Entity to Skunexus

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Skunexus Publisher” as the publisher.
Select the Action that you want the publisher to perform with the data.
Select the Skunexus 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), Put (HTTP PUT method), Patch (HTTP PATCH method) and Delete (HTTP DELETE method) on submitting data to Skunexus.

Entity

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

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

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

Alumio will send an API request to Skunexus with URL /products

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