About the MFTGateway category

anon99371720 · September 21, 2022, 9:57am

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

Extra information

System documentation: MFT Gateway API Reference

Connector package documentation

1. Setting up HTTP Client MFT Gateway

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select MFTGateway Client as the HTTP Client.
Fill in the Base URL, Username, and Password.
(For more information, see MFT Gateway API Reference)
You can optionally enable logging of requests to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from MFT Gateway

2.1 Steps

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

2.2 General Concept

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

HTTP Client

The HTTP Client configuration you will use to access MFT Gateway.

Entity

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

Request Parameters

You can provide these parameters to get the needed entity based on the MFT Gateway API Reference.

Please look at the example below on how to fill the path field when subscribing “Retrieve Inbox (Received) Message” entity.

Based on the documentation, we can see that the endpoint requires an “identifier” as a path. That is why we set the “identifier” inside the path key in the Request Parameters.

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 make a request to MFT Gateway with the URL /message/inbox/%3C15947211062750%40mftgateway.com%3E

Input Transformer

Any transformer’s 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 query parameters of an entity.

3. Publishing Entity to MFT Gateway

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select MFTGateway Publisher as the publisher.
Select the method you want the publisher to use with the data.
Select the MFT Gateway 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). However, you can also add or modify the payload using the Request Transformer.

Method

Currently, we support the POST method, PUT method, and DELETE method in submitting data to MFT Gateway.

Entity

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

For example, we want to use “Create Station” entity. Please select “POST” as the Method and “Create Station” as the entity of the publisher.

Based on the documentation, we can see that the endpoint doesn’t require a path but need a “Request Body”. That is why we set the “Request Body” inside the payload key in the Request Parameters.

Alumio will send an API request to MFT Gateway with URL /station

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.