Deprecation of older versions of the HighQ API

RE: Deprecation of older versions of the HighQ API

Matthew Elcock — Mon, 03 Apr 2023 13:52:00 GMT

I agree with Ryan Mcdonough, why is my org's Swagger defaulting to a significantly older API? We build our logic based on the Swagger documentation under the assumption that it was up-to-date. (Never mind that it's extremely difficult/impossible to search for support threads on this site.)

RE: Deprecation of older versions of the HighQ API

Ryan Mcdonough — Fri, 31 Mar 2023 13:10:00 GMT

Why does Swagger default to version 3 which is clearly deprecated?

RE: Deprecation of older versions of the HighQ API

Jonathan Arndt — Thu, 30 Mar 2023 05:17:00 GMT

Imran Aziz: can you please explain what "first stage" means? We have a client who just now discovered they are still running on v3 for their API calls.
Will all API calls
Or will they work up until the next shipping of an update (which is schedule when)?
Or will they still work, but support will be stopped for any tickets starting Saturday April 1st?

RE: Deprecation of older versions of the HighQ API

Imran Aziz — Tue, 21 Feb 2023 10:32:00 GMT

Ryan Mcdonough Sorry for the late response to your question. With deprecation, we do intend to remove the deprecated API versions from the code to reduce maintenance efforts. In the first stage any API support requests using the deprecated versions of the APIs will no longer be entertained by the support team and the clients will be encouraged to upgrade their implementation.

RE: Deprecation of older versions of the HighQ API

Ryan Mcdonough — Mon, 23 Jan 2023 16:03:00 GMT

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?

RE: Deprecation of older versions of the HighQ API

Ryan Mcdonough — Fri, 16 Dec 2022 14:03:00 GMT

Imran Aziz any response to my questions above?

RE: Deprecation of older versions of the HighQ API

Ryan Mcdonough — Thu, 24 Nov 2022 12:54:00 GMT

Imran Aziz any response to my questions above?

RE: Deprecation of older versions of the HighQ API

Ryan Mcdonough — Thu, 27 Oct 2022 13:30:00 GMT

Imran Aziz - any update on this?

RE: Deprecation of older versions of the HighQ API

Ryan Mcdonough — Mon, 10 Oct 2022 14:51:00 GMT

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?

RE: Deprecation of older versions of the HighQ API

Imran Aziz — Mon, 10 Oct 2022 09:01:00 GMT

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.

RE: Deprecation of older versions of the HighQ API

Gareth Whitten — Sun, 09 Oct 2022 21:09:00 GMT

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?

RE: Deprecation of older versions of the HighQ API

Wallace Cintra — Fri, 07 Oct 2022 12:56:00 GMT

Imran Aziz Great, thank you for clarifying it :)

RE: Deprecation of older versions of the HighQ API

Imran Aziz — Fri, 07 Oct 2022 11:20:00 GMT

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.

RE: Deprecation of older versions of the HighQ API

Imran Aziz — Fri, 07 Oct 2022 11:14:00 GMT

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.

RE: Deprecation of older versions of the HighQ API

Imran Aziz — Fri, 07 Oct 2022 11:09:00 GMT

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.