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

Demo Data

Work with demo data to get started quickly

To help you get started quickly with Human API, we provide a demo data set that is similar to what you will get from a user. This demo data is based on anonymous personal data that we’ve collected.

We provide a demo token that allows you to query the API directly from your application without having to onboard real users or authenticate real data sources. Any stream that is currently available can be queried and the data will change over time (just like it would with a real user).

Accessing Demo Data in the API

To start playing with demo data just use demo as a token instead of a real access token like so:

As a Bearer Token:

-H "Authorization: Bearer demo" https://api.humanapi.co/v1/human

Filtering Demo Data by Source

If you would like to see a payload returned from a specific source, you can use the source query parameter like so:

"https://api.humanapi.co/v1/human/medical/encounters&source=54dc427aaa6b4cb7d6203028"
// this is an example--does not return data

Simulate medical authentication end-to-end

Although you can use the demo token as described above to pull demo data from our servers, in order to see the end-to-end authentication flow you must log in with user credentials in Connect.

We make fictional accounts accessible just like any other account. Follow these steps to connect a fictional account

  1. Launch Connect
  2. When you are prompted to search for a data source, search for Starfleet Medical or Starfleet Pharma.
  3. Use demouser and password as the login credentials

The fictional accounts will have the following datatypes:

  • Encounters
  • Medications
  • Narratives
  • Problems
  • Test Results
  • Vitals
  • CCDs

🚧

How about demo Wellness accounts?

Human API does not maintain demo accounts with Wellness sources such as Fitbit. Please connect your own accounts in order to test end-to-end authentication.

For more information about these datatypes, please visit our medical API reference.

Simulate errors when authenticating medical sources

Authentication by a medical user in Connect may not always be successful due to a variety of factors. This includes action required in the source medical portal, inaccessibility of the source CCD files, an outage at the source portal, etc.

To help simulate those scenarios, we have specific demo user credentials that you can use for testing. See below for more information:

Common scenario

Credentials

Notes

Expected sync status

Technical problem when attempting collection at the source

[email protected] / password

Can use credentials with any source

Error

Terms and Conditions pending approval by the user

attention_demouser / password

Use these credentials only with Starfleet Medical

Attn Required

User has no collectable data at the source

nodata_demouser / password

Use these credentials only with Starfleet Medical

No Data Available

You should see the appropriate error status in the Portal and via the API when using different demo credentials

Updated 2 months ago

Demo Data


Work with demo data to get started quickly

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.