Blog - Details
Options
Related
Recommended

Deprecation of older versions of the HighQ API

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

 

  •

    I'm sorry Imran, but this is not good enough.

    "endpoints might have slight variations"

    " the chances are that they will work"

    "you might need to make slight changes"

    How about you continue supporting the older versions until after "We plan to transfer the HighQ documentation and developer community into the TR developer community with better focus on quality and maintenance" so we have some half decent documentation to work from?

  •

    Gareth Whitten none of the older endpoints will stop working, as we have not discontinued any old endpoints however the endpoints might have slight variations added to address the improvements to the HighQ capabilities. In your API client if you just change the API version to the latest version the chances are that they will work without any change or at the most you might need to make slight changes to include additional parameters.

  •

    Andrew Quinn Thank you for the input and responding to the question of API versions. As Andrew has explained the swagger documentation has a link at the top right corner where you can find the change log. I appreciate the comment about the need to improve the documentation. We plan to transfer the HighQ documentation and developer community into the TR developer community with better focus on quality and maintenance.

  •

    Wallace Cintra the developer community is the place where all partners and clients come to get information about the API so we do not plan to send a client update separately, as all clients using the API would have already received the notice.

  •

    Carl Murphy this deprecation plan is for Collaborate as Publisher does not have that issue at the moment.