- DATE:
- AUTHOR:
- The Trakwell.ai team
Important Notice: API Release Notes
Introduction
We are excited to announce the upcoming release of our API scheduled for October 23rd, 2023. This release brings several important changes and enhancements to our API infrastructure and usage policies. Please read these release notes carefully to ensure a smooth transition to the new version.
Legacy URI Support
The legacy URI for our API will continue to be supported; however, there is a crucial change regarding response handling. Clients making requests to the legacy URI should be prepared to handle 3XX redirection responses Any non-HTTPS requests to the legacy URI will be automatically redirected to the updated URI.
Legacy URI
Base Path: /ords/ws/
Updated URI
FQDN: https://intg.trakwell.ai
Base Path: /ords/doorcounts/api/
Documentation
In this release we will publish OpenAPIv3 documents for both the legacy and the latest released APIs. These documents will provide the data to help you integrate and use our APIs effectively.
The OpenAPIv3 docs will be available on our documentation page at https://help.doorcounts.com/ and will be provided as a REST resource at https://developers.trakwell.ai as soon as possible. We will communicate the availability of the documents when they are available.
Release Communication
To keep you informed about any updates or changes to our APIs, we will provide clear and detailed Release Notes at least one week prior to each release. This proactive communication will ensure that you are well-prepared for any upcoming modifications.
API Usage Policies
Long-Running API Cap
We have introduced a cap on long running APIs, which is set at approximately 1 minute. Any API request that exceeds this duration will be terminated. To avoid such issues, we recommend optimizing your queries by reducing the dateFrom and dateThrough time and concatenating responses when necessary.
Query Limits
Currently, there are no direct caps on the count of records or the size of response payloads, as long as the query execution time remains under one minute.
Asynchronous Request Support
We understand the importance of asynchronous request support, and it is high on our backlog. We plan to implement this feature in future releases to improve the overall user experience.
Future Releases
In the upcoming releases, we will be introducing a data warehouse service to further enhance your data management capabilities. Stay tuned for more information on this exciting addition.
Integration Assistance
We are dedicated to helping you with your integrations. If you have any questions or need assistance with integrating our APIs into your systems, please don't hesitate to reach out to our support team. Thank you for choosing our API, and we look forward to providing you with an enhanced and streamlined experience in this release and beyond.
If you have any questions or require further information, feel free to contact our support team.
If you continue to experience any lingering problems or have any questions, please don't hesitate to contact our support team at support@trakwell.ai.
Rusty Weise
Chief Technology Officer
Trakwell.ai
rusty@trakwell.ai