Human API Developer Hub

Welcome to the Human API Developer Hub. You'll find comprehensive guides and documentation to help you start working with Human API as quickly as possible. Let's jump right in!

Get Started

Apple Health & Apple Watch

What is Apple Health?

Apple Health is an iOS application introduced by Apple in iOS 8. It acts as a central health dashboard for iPhone users allowing them to view health data from numerous health apps in one place. More info on Apple Health can be found here.

Apple Watch data is also accessible via the connection to Apple Health.

Connecting Apple Health to Human API

Sharing data from Apple Health to Human API is a bit different than with most sources. This is because Apple Health data is stored solely on the user's iPhone. To share this data with Human API, we have created a Human API iOS app that users will use in conjunction with Human Connect.

Human Connect

When you enable Apple Health for your application, Apple Health and Apple Watch will be added to the list of sources in Connect.

When a user selects either of these, they will be shown the Human API Sign-Up page below that will allow them to create Human API credentials for use during the second step of the process below.

Human API Connect Sign Up Window

Human API Connect Sign Up Window

Human API iOS App

After creating Human API credentials, your users will be directed to download the Human API iOS app from the App Store.

Once downloaded, there are three steps users must take before data is available:

  1. Sign in with the Human API credentials (created in the Connect popup above)
  2. Grant the Human API app access to each type of data stored in Apple Health as desired
    (this is the data that in turn will be accessible to you via Human API)
  3. Let the app synchronize Apple Health data with the Human API server
Three step authentication process

Three step authentication process

How Often Does Apple Health Data Sync?

Unlike most sources where data resides in the cloud, Human API cannot directly pull updated data at will. Instead, Human API will pull updated health data whenver the Human API application is open.

Handling Data From Apple Health

All data will come through under the source name healthkit.

Other Sources

You can determine where the data originally came from via sourceData.originalSource.

For example, sourceData may have one of the following properties:

// iHealth Example
"originalSource" : "com.ihealthlabs.iHealth02"  

// Withings Example
"originalSource" : "com.withings.wiScaleNG"