View Full API List here
POST AuthorizeMFT Gateway authorization end-point. After successfully authorized, you will receive two tokens api_token and refresh_token. The api_token must be included in the Authorization header of every protected API request. The refresh_token can be used for re-authorization process without user password by using “Referesh Auth Token” end-point.
POST Refresh Auth TokenThis end-point can be used to re-authorize without entering user password, by using refresh-token received from initial authentication.
POST Send MessageRequest Headers
Send(enqueue) AS2 messages with multiple attachments
Response Headers
Request Headers
Response
202 Accepted
Content-Type: application/json
Link: https://api.mftgateway.com/message/outbox/<16037890537199092@mftgateway.com>
{
"message": "Message queued successfully",
"as2MessageId": "<16037890537199092@mftgateway.com>"
}
Response Headers
Similar to the MFT Gateway web dashboard, this simply places the newly submitted message into a queue, in a queued(to-be-sent) state; it may take several seconds before the message actually gets sent out.
Additionally, if the actual send action fails, the message will not appear under the outbox; and the URL previously returned in the Link header would no longer be valid. In such cases it is advised to check outbox/failed and outbox/queued to find out the current status of the message.
POST Mark Received Message As UnReadThis end-point can be used to mark received AS2 message as API unread. Please note that the result of this operation will not be affected on the MFT Gateway dashboard. 5
GET List Received MessagesThis API endpoint can be used to list received messages with optional filters as query parameters.
General filters can be applied along with other filters(primary/secondary) without any restriction
Primary filters have higher precedence over secondary filters. If apply both primary and secondary filters in a single API request, secondary filters will be ignored.
Secondary filters Can be apply single secondary filer per API request. Secondary filters will be applied in the listed order.
GET List Sent MessagesThis API endpoint can be used to list successfully sent messages with optional filters as query parameters.
General filters can be applied along with other filters(primary/secondary) without any restriction
Primary filters have higher precedence over secondary filters. If apply both primary and secondary filters in a single API request, secondary filters will be ignored.
stationAS2Id - AS2 identifier of the AS2 Station that received/sent these messages
Secondary filters Can be apply single secondary filer per API request. Secondary filters will be applied in the listed order.
GET List Queued MessagesThis API endpoint can be used to list queued(pending-send) messages with optional filters as query parameters.
General filters can be applied along with other filters(primary/secondary) without any restriction
Primary filters have higher precedence over secondary filters. If apply both primary and secondary filters in a single API request, secondary filters will be ignored.
stationAS2Id - AS2 identifier of the AS2 Station that received/sent these messages
Secondary filters Can be apply single secondary filer per API request. Secondary filters will be applied in the listed order.
GET List Failed MessagesThis API endpoint can be used to list send failed messages with optional filters as query parameters.
General filters can be applied along with other filters(primary/secondary) without any restriction
Primary filters have higher precedence over secondary filters. If apply both primary and secondary filters in a single API request, secondary filters will be ignored.
stationAS2Id - AS2 identifier of the AS2 Station that received/sent these messages
Secondary filters Can be apply single secondary filer per API request. Secondary filters will be applied in the listed order.
GET Retrieve Inbox(Received) MessageThis API endpoint can be used to retrieve received message with optional markAsRead(Boolean) query param. If this is set to true, the message will be “marked as read” upon retrieval. Defaults to true. Any list queries with fetchAll=false will not return it afterwards. You can combine this and the fetchAll query parameter, to ensure one-time processing of received messages. (Note that this marking happens only at API scope; marked messages may still appear as unread on the MFT Gateway web app inbox.)
GET Retrieve Outbox(Sent/Queued/Failed) MessageThis API endpoint can be used to retrieve outbox(sent/queued/failed) message by AS2 message identifier.
GET Retrieve Inbox(Received) Message Attachment(s)This API endpoint can be used to retrieve pre sign URL(s) to download received message attachment(s) from Amazon S3 bucket. Please note that validity of the S3 signed URL is limited to 10 minutes.
GET Retrieve Outbox(Sent/Queued/Failed) Message Attachment(s)This API endpoint can be used to retrieve pre sign URLs to download received message attachment(s) from Amazon S3 bucket. Please note that validity of the S3 signed URL is limited 10 minutes.
GET Retrieve Inbox(Received) Message MDNThis API endpoint can be used to retrieve S3 pre sign URL to download Sent MDN from Amazon S3 bucket for a received message. Please note that validity of the S3 signed URL is limited 10 minutes.
GET Retrieve Outbox(Sent) Message MDNThis API endpoint can be used to retrieve S3 pre sign URLs to download a received MDN from Amazon S3 bucket for a successfully sent message. Please note that validity of the S3 signed URL is limited 10 minutes.
Experience the world's first Serverless Managed File Transfer Gateway implemented on Amazon Web
Services (AWS)!