Samsung Health Android SDK


Samsung Health Android SDK enables sharing health data between Samsung Health running on Android phones and partner apps. It also enables partner apps to use Samsung Health's tracker feature through app creation with the SDK. Samsung Health's partner apps can provide their users with additional services with Samsung Health Android SDK.

The SDK provides secure access to Samsung Health data with applicable data types. Data sharing, however, is enabled only after the user's explicit consent. The user can select detailed data sharing settings including which partner app will access the user's data, and which data type will be read or written. Furthermore, a partner app can launch a Samsung Health's tracker and define its own tracker tile.

Samsung Health Android SDK is composed of Health Data and Health Service.

Health Data

Health Data has the following features:

  • Health Data Store

    Samsung Health Android SDK keeps users' health data secured. The health data store handles the service connection. It facilitates reading Samsung Health's data or writing the partner's health data to Samsung Health.

  • Health Data Type

    It provides useful predefined types and custom data types. Each data type is designed to contain a given health data type's information. It is used to access the data in Health Data Store.

  • Permissions and User Controls

    The user's health data are sensitive information. Handling data with the SDK is only available with the user's explicit consent. Health Data provides a unified user interface and gives the user control of the data sharing settings easily for each data type.

Health Service

Health Service has the following features:

  • Launching Samsung Health Tracker

    The tracker manager helps to launch a specific Samsung Health’s tracker like "Steps" or "Water". The app can select a tracker and its destination where Samsung Health supports. The launched tracker can be used to check the latest health data or save a new data though Samsung Health. It is a convenient way for a partner app to add new data. Data recorded through the Samsung Health’s tracker are saved in Samsung Health.

  • Posting Partner App's Tracker Tile

    The tracker tile manager enables a partner app to define and post its tracker tile on Samsung Health. The partner app's tracker tile can be visualized with the app icon, relevant health data, and a button with an action in three types of the tile form. A posted tracker tile is displayed on the main screen of Samsung Health. The user can select the partner app's tile in Samsung Health > Manage items.

Partner Apps Program

Partner App Program is an exclusive service for Samsung Health that allows users to discover engaging health and fitness applications. To enable data exchange between your app and Samsung Health, please apply for the Partner App Program.

Approved partner apps are displayed in Samsung Health > Discovery > Featured apps.

Partner App Program Process

Partner App Program is an exclusive service for Samsung Health that allows users to discover engaging health and fitness apps. To enable data exchange between your app and Samsung Health, please apply for the Partner App Program. Approved partner apps are displayed in Samsung Health > Discovery > Featured apps.

1. SDK Download

Download Samsung Health Android SDK along with related documents.

Samsung Health Android SDK Data (v1.4.0) April 11, 2019 | Service (v1.4.0) Nov 28, 2019

2. App Integration

Integrate Samsung Health Android SDK into your app.

3. Test

Test your app with checklist and the DataViewer tool before applying for the Partner App Program.
Your app needs to be seamlessly integrated with Samsung Health and free of bugs.

4. Apply for Partner App

Apply for the Partner App Program by submitting the request form.
Samsung Health team reviews your app.

5. Partner App Approval

Once your app is approved, Samsung Health connection works in non-developer mode.

6. Publish Your Application

Publish the approved app.

Connection Design Guide

Samsung Health's partner apps connect to Samsung Health with Samsung Health Android SDK. Unified interfaces in partner apps seamlessly connect with Samsung Health to provide uninterrupted user experience to the users. For the best result, please see Connection Design Guide.

  • Notification of Samsung Health connection

    The launch screen of a partner app, event pop-up, or information space is a good approach to notify users of connecting with Samsung Health. A partner app needs to inform users with as concrete description and information as possible.

  • Menu for Connecting to Samsung Health

    A partner app should provide a menu with a convenient interface for the user to change the data sync setting with Samsung Health.

  • Samsung HealthName & Icon

    Samsung Health's name and its icon should be used properly in a partner app.

Restrictions

  • Samsung Health Android SDK runs on devices with Android 6.0 Marshmallow (API level 23) or above.

  • It requires Samsung Health installation. The latest SDK works with Samsung Health 6.2 or above.
    See the SDK and Samsung Health’s compatible versions here.

  • An app’s targetSdkVersion that uses Samsung Health Android SDK should be 26 or above.

  • Samsung Health is available on all Samsung smartphones and also non-Samsung Android smartphones with Marshmallow or above.

    The SDK provides APIs to check whether the device supports the SDK. See FAQ for more information.