Although the WebTMA Platform API uses Swagger, a certain amount of setup is needed in both the WebTMA application as well as Swagger. If you want more Swagger information, go tohttps://documentation.tmasystems.net/.
NOTE: If you use a backslash ( \ ) in your login for API, JSON requires you to use a double-backslash ( \\ ).
Add API Role for User in WebTMA
Path: Admin > User Management > Records
When logged in to the WebTMA application:
- Go to Admin > User Management > Records and open the desired User record.
- Choose the API Roles Tab.
- Select Edit on the toolbar.
- Select the Add Role link.
- Mark the desired roles on the API Role Selection flyout.
- Choose the Add Selected button.
- Select Save on the WebTMA toolbar.
Swagger Settings
Take following actions after you launch https://webtma.com/platformapi/swagger/index.html.
Users Endpoint
- Expand Post in Users.
- Select the Try it out button.
- Look to the Request body section.
- Enter the Username / Password / Client of the user you configured in WebTMA.
- Select Execute.
Token to Authenticate
A Token to authenticate displays in the Response body section.
- Copy the Token within the quotes.
- Go to the top of the Swagger page.
- Click the Authorize button at the right side of the page.
- Paste the token in the Value field of the Available authorizations popup window.
- Select the Authorize button on the popup.