ballerinax/mft Ballerina library

Overview

This is a generated connector for MFT REST API v1.0 OpenAPI specification. The MFT REST API provides a secure AS2 secured channel for such communications, and offers your company, multiple ways to upload/download files, or automate the exchange through integration mechanisms.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create a MFT account
• Obtain tokens following this guide.

Quickstart

To use the MFT connector in your Ballerina application, update the .bal file as follows

Step 1: Import connector

First, import the ballerinax/mft module into the Ballerina project.

import ballerinax/mft;

Step 2: Create a new connector instance

Create a mft:Client instance using an API token.

mft:Client mftClient = check new ({authorization: <VALID_API_TOKEN>});

Step 3: Invoke connector operation

1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

   Following is an example on listing received messages.

   List Received Messages

   public function main() {
       SuccessfulMessageListRetrievalResponse messageResponse = check mftClient->listReceivedMessages();
       if messageResponse.messages == [] {
           io:println("No messages received!!");
           return;
       }
       foreach var message in messageResponse.messages {
           io:println("MESSAGE ID >>>" +message.toString());
       }
   }

   Following is an example on single message retrieval.

   Retrieve an Inbox (Received) Message

   public function main() {
       AS2Message messageResponse2 = check mftClient->retrieveInboxMessage(messageResponse1.messages[0]);
       io:println(">>>", messageResponse2);
   }

   Following is an example on listing certificates available.

   List Certificates

   public function main() {
       SuccessfulCertListRetrievalResponse listCertificates = check mftClient->listCertificates();
       io:println(listCertificates);
   }

2. Use bal run command to compile and run the Ballerina program.