Related
Recommended
Imran Aziz

In our continued effort to provide a high level of service and support to our partners and clients, we plan to deprecate our old API versions. To give sufficient time to our partners to upgrade their integrations we plan to deprecate and consider "end of life" for the older versions of the API from API version 1 to API version 10 on 31st March 2023. On the 31st  of March 2023, all versions before and including API version 10 will reach their end of life and no support will be provided for those API versions by the HighQ support team. 

API version 11 will have end of life on 30th June 2023, version 12 on 31st of December and API version 13 on the 30th of June 2024.

Going forward with the release of the new version of the API, the previous versions will be considered deprecated and will only be supported up to two years from the day of deprecation.

As an integrator using HighQ API can you please make sure that you upgrade your integrations to the latest version of HighQ? The latest version of HighQ API was released with the June release of HighQ, which is API version 14.

Please follow the API release notes to determine what has changed in each API version. All previous release notes have been provided until HighQ 5.6 and from HighQ 5.7 release notes are provided with the swagger documentation.

For any further details please contact the HighQ support and product team. 

Thank you,

The HighQ product and engineering team

 

  •

    Imran Aziz any response to my questions above?

  •

    Imran Aziz any response to my questions above?

  •

    Imran Aziz - any update on this?

  •

    Imran Aziz So to check a few things:

    Deprecation - does this mean they'll no longer work? Or is it just support that wont be provided?

    If it's just support being removed, are you expecting to fully remove older endpoints at somepoint the in future.

    Will you start returning messages in the responses in a brown out style degredation so integration logs will start to see this is being deprecated?

    How long will API versions be supported going forward? 2/3 years?

  •

    Gareth Whitten I appreciate your concern but we are unable to provide exact guidance without knowing which API version you are at, if you are still using version 3 of the API and have not updated your application for 5 years then you will need to review all of the release notes and guidance we have provided for each release till today, as we are now on version 14 of the API. However, if you are on version 13 of the API then the process is very simple to check the release notes from version 13 to 14. It is the responsibility of the integrator to make sure that they stay up to date with the API versions. All previous release notes have been provided until HighQ 5.6 and from HighQ 5.7 we have been providing release notes in the Swagger documentation.

    As I pointed out in my previous post we have made sure that our API's are backwards compatible and just changing the API version access from the older version to API version 14 will work, however, some capabilities will need additional API parameters to use the new features. You will not know the result without trying it out, please proceed with your upgrade to use the new API version and if you have any problems then please raise the question with the support team and we can guide you through the upgrade process.