Join 34,000+ subscribers and receive articles from our blog about software quality, testing, QA and security.
 

Old API documentation link is no longer valid


#1

The following old API link shown on google no longer points to the old API documentation:

It now redirects to:

http://docs.gurock.com/testrail-api2/start

Is there a new link for the old documentation?

Out of interest - I know the old API is deprecated (and we prefer the new API), but do you know if the latest miniapi files (testrail-miniapi2-v16-4.0.zip) will still work as-is with TestRail 5.x?

If not, we have a fair bit of work ahead of us to migrate some internal test frameworks to remove the usage of the old API!


#2

Hello Glenn,

We now redirect the old API to the new one and would recommend migrating existing code to the new API. The required changes are minimal and the new API is a lot better and consistent than the old one. We no longer support the old API with TR 5.0 unfortunately. The sub-pages for the API are still available currently and you can find a migration guide here:

http://docs.gurock.com/testrail-api/migration

The list of pages is as follows (but will be redirected in the future as well):

http://docs.gurock.com/testrail-api/accessing
http://docs.gurock.com/testrail-api/errors
http://docs.gurock.com/testrail-api/installation
http://docs.gurock.com/testrail-api/introduction
http://docs.gurock.com/testrail-api/migration
http://docs.gurock.com/testrail-api/reference-cases
http://docs.gurock.com/testrail-api/reference-cases-types
http://docs.gurock.com/testrail-api/reference-milestones
http://docs.gurock.com/testrail-api/reference-plans
http://docs.gurock.com/testrail-api/reference-priorities
http://docs.gurock.com/testrail-api/reference-projects
http://docs.gurock.com/testrail-api/reference-results
http://docs.gurock.com/testrail-api/reference-runs
http://docs.gurock.com/testrail-api/reference-statuses
http://docs.gurock.com/testrail-api/reference-suites
http://docs.gurock.com/testrail-api/reference-tests
http://docs.gurock.com/testrail-api/reference-users

I hope this helps!

Regards,
Tobias


#3

Damn - I was hoping there would be a solution to the inability to extend APIv2 before compatibility was completely dropped :frowning:


#4

Sorry Glenn, the old API has been difficult to maintain/further support and migrating to the new API is fairly simple, as the API calls are pretty similar:

http://docs.gurock.com/testrail-api/migration

You would also benefit from many new methods and options so hopefully any older customizations wouldn’t be needed anymore.