About the AS2 Gateway category

o.plokha · April 8, 2024, 7:49am

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

Extra information

System documentation: AS2 Gateway API Reference

Connector package documentation

1. Setting up HTTP Client AS2 Gateway

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select AS2 Gateway HTTP Client as PlatForm and click next step
Fill in the Base URI, Username and Password.
You can optionally enable caching of the token and set Alumio storage to store the token.
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 AS2 Gateway

2.1 Steps

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

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing "Retrieving a Received AS2 Message entity.

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

Alumio will then make a request to AS2 Gateway with the URL /v1/message/received/<1612348314.4843.1712128400537@as2gateway.com>

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 AS2 Gateway.

3. Publishing Entity to AS2 Gateway

3.1 Steps

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

Entity

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

For example, we want to add a new contact. Please select “Post” as the Method and “Sending AS2 Messages” as the entity of the publisher.

Based on the documentation, it requires “as2_station_id” and “as2_partner_id” as parameters, it also requires multipart request body. Please go into the “Advanced” tab and set the “as2_station_id” and “as2_partner_id” inside the path key inside Advanced Path Parameters. Then we set “Body type” as “Multipart/form-data”. Because AS2 require file as Key, please always set the Key into file. Please set the other field as you need.

Alumio will send an API request to AS2 Gateway with URL /v1/message/ALUMIO123/PARTNER123

Path Parameters is the path parameter of the url. For example the {id}.
Query Parameters is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Body Type and Parameter will determine the data you will send inside the request