Setup your environment
Before diving into the integration process, let's start by setting up your developer account and creating your application.
If you’re unsure which cloud environment you should be using, check with your project manager to ensure you're aligned with the medical certification requirements for your region.
Cloud Environment Selection
Withings offers its services on different cloud environments, depending on your medical certification needs.
The APIs are identical across clouds.
Cloud Name / Certification | Prerequisites | Endpoint |
---|---|---|
EU Medical Cloud / Public Cloud | GDPR compliant, ISO 27001:2017, and HDS certified. No prerequisites; free access is available. More about limitations. | https://wbsapi.withings.net |
US Medical Cloud | HIPAA and GDPR compliant, ISO 27001:2017 certified. Available only for partners with a signed contract. | https://wbsapi.us.withingsmed.net |
Creating Your Application
Once you've selected your cloud environment, the next step is to create a Withings account for your integration. While you can use your personal Withings account, we recommend creating a new account specifically for your organization using a shared professional email address. This ensures a clean separation between personal and professional use.
Creating an application will provide you with the necessary client_id
and client_secret
to access Withings services.
You can go back to the Developer Dashboard at any time if you want to update or delete your application.
Manage Your Team
To collaborate with your colleagues, go to the Teams section and invite them to your organization.
You can assign them one of three roles: Admin, Developer, or Support Agent.
Below is a breakdown of the roles and the features they can access:
Description | Admin | Developer | Support Agent |
---|---|---|---|
Create, edit, delete applications in dev, beta environments. | Yes | Yes | - |
Create, edit, delete applications in dev, beta, and prod. | Yes | - | - |
Invite users and revoke access. | Yes | - | - |
Update the organization’s information. | Yes | - | - |
Access the device list and the details of those devices. | Yes | Yes | Yes |
By assigning the appropriate role to each member of your team, you ensure they have the right level of access and control based on their responsibilities.