Using the Swagger UI API
Swagger is an open-source set of specifications, tools, and rules for developing and describing RESTful APIs. The Swagger framework lets developers create interactive, machine-readable, and human-readable API documentation.
Using Swagger at MFT
MFT engineers have created a Swagger page to document APIs. Each PUT, GET, POST call is listed on the page for each section of the UI. The Schemas listed at the bottom of the page are associated with the calls listed.
You may find that some calls may not use the entire associated schema that is listed on the MFT Swagger page under Schemas.
Testing APIs with Swagger
All the documented APIs can be tested on the Swagger page, by clicking Try It. You must first authenticate by creating a user token or API Key to use the Try It button.
Authorization
API Authentication can be achieved in two ways:
- User Token Authentication - Expires in 24 hours.
- API Key
To use your newly created token, click the Authorize button. This action begins your session. The token will be applied automatically each time you click the Try It button, which is located in the upper right-hand corner of the MFT Swagger page.
Navigating to your MFT Swagger page
Your Swagger page can be accessed easily by navigating to your login page and then type the /swagger at the end of the URL. Below are examples for each region instance.
| Region | URL |
|---|---|
| US | https://us.thruinc.com/swagger |
| UK | https://uk.thruinc.com/swagger |
| GER | https://eu.thruinc.com/swagger |
| AUS | https://au.thruinc.com/swagger |
