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 Authorization
1.2.1 Authorization using API tokens
The REST API supports authentication using API tokens, in addition to the legacy username and password authentication.
Users can create up to 10 API tokens.
Each API token can be assigned one of four distinct access levels: Organization Admin, Management, Regular, or Read-Only. These levels grant permissions identical to the corresponding MFT Gateway user levels.
Upon successful creation, a CSV file containing the Token ID and Token Secret will be automatically downloaded.
Important: For security reasons, the Token Secret is accessible only during its initial creation. Ensure it is securely stored. If the secret is lost, the token must be revoked or deleted, and a new one generated.
1.2.2 Authorization using username and password (legacy)
REST API supports authorization using MFT Gateway username and password. For security and access control, it is recommended to create a dedicated user account with the appropriate user level in your MFT Gateway account specifically for REST API access.
