Terminal Management TMX includes an API that may be used to manage orders and details of the system.
Applies to:
- Terminal Management TMX
Full documentation for the Terminal Management TMX API can be found on the “About” page, found via the blue navigation bar on the left side of the screen.
To use the API in Terminal Management TMX, there are a few prerequisites:
- Access - The API requires a connection to the Terminal Management TMX Server, either by being local to the server on the network, having VPN access to the network of the server, or by exposing the web interface of the server where it will be accessible.
- Validation – Connecting to the API uses a randomly generated “Client ID” token that attests that the application may connect to the system. A Client ID is created in Terminal Management TMX under “Interfaces” > “API Clients.” The Client ID has some settings tied to it, configuring if other applications may edit or delete changes that are made by the API. There is also history tied to the Client ID, allowing for the review of any actions that are taken using it.
- Permissions – A username and password for an account made in Terminal Management TMX is required and sets the permissions for what may or may not be managed with the API. If the user account does not have permission to view or perform an action in a section of Terminal management TMX, the command will be rejected.
This overview is intended for developers interested in tying into Terminal Management TMX.
Still Need Help?
Submit an online web ticket or call Kahler Automation at 507-235-6648 option 2.