Overview
As part of our commitment to enhanced security and performance, we are updating our API access method. Starting January 2025, all API requests must be made via {tenant}.aptem.co.uk. This new approach allows for greater customisation and security tailored to each tenant.
Please review this guide to ensure a smooth transition and continued service. Note that OData URLs will not be affected by this change.
Dates to remember
- We strongly recommend that customers discontinue the use of api.aptem.co.uk by 2nd January 2025.
- Use of api.aptem.co.uk will be permanently deprecated on 3rd February 2025, with no possibility of extension. We request that you complete your migration work at the highest priority to avoid any service disruption.
How to update your API calls
- Update all instances where you reference Aptem's API in your codebase or configuration, replacing any use of api.aptem.co.uk with {tenant}.aptem.co.uk where {tenant} is the name of your tenant. For example:
- Before: https://api.aptem.co.uk/api/1.0/tenants/{tenant}/users
- After: https://{tenant}.aptem.co.uk/api/1.0/tenants/{tenant}/users
- We recommend testing each instance where you have made updates, to ensure there are no issues with connectivity or data handling. Note that the update to the API will not cause any change in functionality.
Additional Tips
-
Check for redirects: If you are using a third-party service, ensure it does not automatically redirect calls from the legacy endpoint. The new endpoint must be explicitly set for every request.
-
Consult the updated API documentation: Detailed information, including examples and response codes, is available in our API documentation.
Impact of not updating
We strongly recommend that customers discontinue the use of api.aptem.co.uk by 2nd January 2025.
Use of api.aptem.co.uk will be permanently deprecated on 3rd February 2025, with no possibility of extension. After this, any API calls directed to api.aptem.co.uk will no longer be processed, potentially disrupting your workflows and applications. It’s crucial to complete this transition ahead of time to avoid interruptions.