REST API Integration
1 Introduction
The MFTGateway exposes a complete REST API for integration. This includes authorization for access, message sending and access, Station and Partner management, and Certificate management.
1.1 REST API Endpoint
The REST API is available at https://api.mftgateway.com/. The complete API list and documentation with examples code snippets can be found here.
OpenAPI 3.0 specification for the REST API can be found below.
1.2 Available APIs and details
2 Deprecation Notice and Change Summary
In order to be compatible with multiple message services, MFT Gateway has made some changes to the existing message-related API endpoints. Below is a high-level summary of the REST API changes.
Request body changes:
| Old JSON Object Key | New JSON Object Key |
| as2MessageIds | messageIdentifiers |
Request query parameter changes:
| Old Parameter | New Parameter |
| as2MessageId | identifier |
| stationAS2Id | stationIdentifier |
| partnerAS2Id | partnerIdentifier |
| - | service |
Path variables changes:
| Old Variable | New Variable |
| as2_message_id | identifier |
Response changes:
| Old Field | New Field |
| api_token | apiToken |
| refresh_token | refreshToken |
| as2messageId | messageIdentifier |
| as2MessageId | identifier |
| senderAS2Id | senderIdentifier |
| receiverAS2Id | receiverIdentifier |
| serialNumber, serial_number | serialNumberHex, serialNumberDecimal |
| subject_common_name | subjectCommonName |
| subject_distinguish_name | subjectDistinguishName |
| issuer_common_name | issuerCommonName |
| issuer_distinguish_name | issuerDistinguishName |
| valid_from | validFrom |
| - | validFromTimestamp |
| - | expiryTimestamp |
MFT Gateway will support both old and new fields/parameters for backward compatibility in current versions, and will remove old ones completely after 01st of May 2024.