The Withings API is a set of web services that allow third parties to develop applications
that allow users full access to their recorded health data. Access to the API and the services
it provides is free of charge. Experience shows that applications and websites dedicated to
health and fitness who integrate the measurements from Withings products benefit from
increased consumer loyalty, higher subscriptions to premium services and higher renewal
rates.
The API is designed to be as easy to integrate with third-party environments as possible.
Sample code is provided in the documentation to illustrate best practices for using the API
and to provide a starting point for new Withings-linked applications.
Using the Withings API, developers will have the ability to access health data measured
by Withings products, including weight, fat mass, lean mass, blood pressure and heart rate.
There is no delay in the transmission of data: as soon as the Withings servers receive the
new measures, they are pushed to all connected applications and dashboards chosen by the
user. This allows third-party dashboards to become much more reactive and overall improves
customer experience.
Already integrated the Withings API ? Check our affiliation program [LINK] to offer the
most complete experience to your customers.
Identification and Authentication
You typically use the Withings Web API to retrieve data related to a given user, for example,
weight and blood pressure. A user is part of an account.
An account is what Withings users use to log into their dashboard. An account is uniquely
defined by an email address. For access to be granted to a given account, its password (chosen
by the user at registration time) is needed.
Authentication is made via OAUTH. To access the API via OAUTH, your app must be hosted
on an external server.
When accessing the API via OAUTH, the user account credentials must be entered (email
address and password). Once authenticated, the user will not be asked to log in again until the
session expires.
To learn more about OAUTH, please see http://oauth.net/
Notification Service for Third Parties
The most effective way for third parties to retrieve measurement updates is to setup
notifications (some might call it "Push") for the users they are interested in. Each time the
subscribed users upload their health data, the Withings Web API will send notifications to all
their monitoring third parties. Subscription to the notifications is managed by the third party
application, not the user.
When the Withings Web API sees that subscriber data has been modified, it sends a
notification to the subscribing third party application. The notification contains information
that helps to determine what should be downloaded to remain in sync.
Notifications subscriptions last until the user or the third party application unsubscribes from
the notification service.
The subscription can be revoked at any time. To find out more, please contact us at contact-
mkt AT withings.com.
Register
See full documentation
See our proposal for affiliation