...
User Authorization & Data Processing for Dropshipped Cellular Devices
| Table of Contents | |
|---|---|
|
...
|
Overview
Withings cellular devices are offered with two procurement workflows:
...
This guide details the Withings Pro and Inform APIs that clients will need to implement in order to create and manage the data connection between Withings Pro and Validic Inform on behalf of the end user.
...
The required steps are:
Provision a user in Validic Inform
Dropship and activate the cellular device using Withings Pro APIs
Establish the user device connection between Withings Pro and Validic Inform
Receive Withings Pro data in Validic Inform
...
Let’s get into the individual steps.
...
Provision User in Validic Inform
Sample Request
Content-Type: application/x-www-form-urlencoded
...
"updated_at": "2023-07-06T21:19:08Z"
}
...
Dropship and Activate Device with Withings Pro APIs
Withings documentation: https://developer.withings.com/developer-guide/v3/integration-guide/dropship-cellular/logistics-api/create-user-order
...
Withings base url:
https://wbsapi.us.withingsmed.netThe information included in the response received from the Withings OAuth2-v2 Requesttoken endpoint will be used in the next step to establish the user device connection in Inform.
The client will not use the “Notify Subscribe” endpoint in the Withings API. The Validic Inform integration will subscribe for data updates automatically once the user connection is established.
If the client prefers to have Withings devices bulk shipped, that is also possible using the instructions here: Withings Pro Inform Integration Bulk Shipping Process
...
Establish User Device Connection
Sample Request
Content-Type: application/json
...
:withingsscopes is the granted Withings scopes (scopes)
Note:
Once this endpoint is used to submit the user’s Withings tokens to Validic Inform, Inform will be the source of truth for the tokens. Inform will update and manage the tokens to ensure data access is maintained, therefore, no other processes should make calls to Withings to adjust the tokens.
If the tokens must be re-generated for any reason then the user must be disconnected from Withings Pro in Inform first. And then new tokens must be submitted to Inform using the “Establish User Device Connection“ endpoint.
All values are strings
scopes is an array of strings
Clients will calculate the expires_at date/time based on the time the Withings’ OAuth2-v2 Requesttoken response is received by adding Withings' expires_in to the response date/time.
expires_at format must match the following: YYYY-MM-DDTHH:MM:SSZ (e.g.,
2023-07-12T23:00:00Z)
...
Sample Response
202 Accepted
| Note |
|---|
Once this endpoint is used to submit the user’s Withings tokens to Validic Inform, Inform will be the source of truth for the tokens. 'Inform will update and manage the tokens to ensure data access is maintained, therefore, no other processes should make calls to Withings to adjust the tokens otherwise data syncing will be interrupted and the user will be automatically disconnected from Withings Pro in Inform. |
Disconnect User
The Validic standard or custom marketplace is used to determine the user’s current connection status to Withings Pro. The Withings Pro source can be disconnected using the disconnect_url returned by the Validic marketplace, such as the following:
...
The Withings Pro Inform integration supports the following data metrics:
...
Metric Type
...
Resource
...
Definition
...
Data Type
...
Unit
...
body_weight
...
measurements
...
Body weight measurement of the individual.
...
float
...
kg
...
diastolic
...
measurements
...
The diastolic blood pressure measurement of the individual.
...
float
...
mmHg
...
systolic
...
measurements
...
The systolic blood pressure measurement of the individual.
...
float
...
mmHg
...
pulse
...
measurements
...
The heart rate reading of the individual.
...
integer
...
data metrics defined on the Standard Metrics Used Per App page (see “Withings Pro” app).
Sample Data
The below example illustrates a single weight measurement using the Body Pro scale and a single blood pressure measurement using the BPM Connect Pro blood pressure monitor.
...