Important changes to API authentication

We recently made some updates to improve how you login to TestLodge. Now, we are also making improvements to the way you authenticate and access our API.

If you do not use the TestLodge API, no action is required. But if you or a member of your team do use it, you will soon need to make some minor updates to the authentication.

The current way to access the API is to add your user email and password to authenticate each request. This will be changing soon and in future, you will use your email and API key to authenticate. This article on API Basics will help you with how to generate the API key.

The way you authenticate at the moment will continue to work for the time being. This is to allow you to migrate to the new method with as little disruption as possible.  We have tried to keep your code changes to a minimum so all you will eventually have to do is switch from using your password to use the API key’s token instead.

Important Dates

For now, the password that you set up before May 8th will continue to function, but we have scheduled the following two dates as steps towards the change. To continue to access the API without issue after June 1, please generate your API key before the end of May.

  • June 1st 2021 - API requests that use a pre-May 6 password will begin failing periodically for short periods of time. This will alert users who have not made the switch yet to make the change before we fully disable the old authentication.

  • July 1st 2021 - Old password authentication will be fully turned off and you will no longer be able to authenticate using a password after this date.

If you have any questions about any of the above, please get in touch with us through our support portal.