Trio VMS API Migration Guide
Authentication Changes
From Basic Authentication to API Key Authentication
The Trio VMS APIs are transitioning from Basic Authentication to API Key Authentication to enhance security and align with industry best practices.
Old Method (Basic Authentication)
- Required encoded username and password sent with each request
- Less secure due to frequent transmission of credentials
New Method (API Key Authentication)
- Uses unqiue API keys for each user or application
- Provides more granular access control
- Individual API keys can be revoked and set to expire
- Improves overall security
Migration Steps
- An API key can be obtained in two ways from the Trio VMS application.
- Generate an API key from your User Profile page.
- Request an API key from your MSP contact.
- Generate an API key from your User Profile page.
- Modify your API requests to remove the
Authorization
header and replace it with anX-Api-Key
header that contains your API key. - Test your integration with the new authentication method.
- Phase out usage of Basic Authentication.
Base URL Change
The base URL for API access is changing to accomodate building out additional APIs, simplified infrastructure and routing, and improve performance.
Update all API endpoint URLs in your integration to the new URL. If you are working with AHSA as your MSP, the url will be https://api.triovms.com/ahsa/api
Old URL
New URL
API Version Migration (v2 to v3)
Trio VMS is encouraging users to migration from the v2 APIs to the v3 APIs. The v3 APIs offer enhanced functionality, additional properties, and improved performance.
Trio is deprecating the v2 APIs. They will no longer receive enhancements and will eventually be shut down. The v2 APIs will not be available at the new URL.
Refer to API v2-v3 Migration for specific details on differences and migrations steps to convert from v2 APIs to v3 APIs.