Important: If you are unable to resolve your developer-related question via our public Help Center articles, please visit the Developer Dashboard here. Within the developer dashboard, you will be able to submit a support ticket that will be answered by our dedicated team.
Timeline
- Announcement Date: 03/16/2021
- Shut Down Date: 02/08/2022
Description
Impacted actions
Deprecated endpoint
- POST: https://account.withings.com/
oauth2/token - POST: https://account.us.withingsmed.com/oauth2/token (HIPAA & HDS Cloud)
New endpoint
- POST: https://wbsapi.withings.net/
v2/oauth2 - POST : https://wbsapi.us.withingsmed.net/v2/oauth2 (HIPAA & HDS Cloud)
New input parameters :
When calling the new endpoint, you must specify an action parameter. All information about the input parameters can be found here :
https://developer.withings.com/api-reference/#operation/oauth2-getaccesstoken
New response format
- Response when using the deprecated endpoint you received:
{
"access_token": [{string} Your new access_token],
"expires_in": [{integer} Access token expiry delay in seconds],
"token_type": [{string] HTTP Authorization Header format: Bearer],
"scope": [{string} Scopes the user accepted],
"refresh_token": [{string} Your new refresh_token],
"userid": [{string} The Withings ID of the user]
}
- Response when using the new endpoint you will receive:
{
"status": [{integer} Withings API response status (cf. https://developer.withings.com/oauth2/#section/Response- status)],
"body": {
"access_token": [{string} Your new access_token],
"expires_in": [{integer} Access token expiry delay in seconds],
"token_type": [{string] HTTP Authorization Header format: Bearer],
"scope": [{string} Scopes the user accepted],
"refresh_token": [{string} Your new refresh_token],
"userid": [{string} The Withings ID of the user]
}
}
Am I impacted?
- You are impacted if you are using the deprecated endpoint to get and refresh access_token
What has changed?
- The endpoint changed as specified described above
- The request output also changed
Do I need to change the url for the authentication code?
No. The url to get the authentication code remains unchanged. See documentation.
- https://account.withings.
com/oauth2_user/authorize2 - https://account.us.withingsmed.com/oauth2_user/authorize2 (HIPAA & HDS Cloud)
How can I switch from the previous endpoint?
- Until the release date of the new endpoint, both endpoints will remain available to get and refresh access_tokens
- Before the release date of the new endpoint, you must replace the deprecated endpoint with the new endpoint and apply the modifications shown above