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

 

  •

    Gareth Whitten, the ChangeLog of API link, in the top-right of the showSwagger UI has some details about endpoint versions, and their changes, but it too is in the same vein as the rest of the Thompson Reuters "documentation". It sometimes references:

    Please refer swagger UI page (contextName/showSwaggerUI.action) for this end point for detailed information.

    Only for it to be missing, non-existent, or stretching the english word "terse" to it's linguistic limits. It's just a good job this s/w platform is free...


    ]]>
  •

    Thanks Ryan McDonough, I know about api/x x being the version. But I didn't even know there was anything above 3.

    Do they support api/latest? What end points are going to stop functioning?

    Who know without adequate documentation!

  •

    So Gareth Whitten you'll see which API version in the URL /api/3 would be version 3, api/10 would be version 10 - that's just for knowing which version you're using - seems like everyone's instance (assuming it's been upgraded) is running every version... somehow....

    But yeah as for the documentation it's so poor and really needs fixing before they go down this route.

  •

    Hello Imran Aziz, you're talking about API versions 1 to 10 being unsupported from March next year.

    How do I know what API version I'm using (for Collaborate)?

    Your documentation mentions api (no version), version 2, and some of your examples include api/3/ but you don't appear to have any information available about what is in what version, how are we meant to know what is and isn't in version 10+?

    Thanks

  •

    Will this mean a proper move to versioned API endpoints and an explanation of what is specifically changing from version to version?

    As well as propertly up to date swagger with all the endpoints documented not just a small subset?