Overview
Spike API is designed for developers who want to seamlessly connect their applications to user health data from multiple providers. Below is a high-level guide to the main components of the integration process. Each section links to detailed documentation.
Authentication
Securely authenticate your users using HMAC signatures and access tokens. This step ensures that only authorized users and applications can access sensitive health data.
Read the Authentication documentation →
Provider Integration
Connect your users to health data providers (such as Garmin or Fitbit) and manage consent flows. This enables your application to access user data with proper authorization.
Read the Provider Integration documentation →
Webhooks
Receive real-time updates when user data changes or new data is available. Set up webhook endpoints to automate data ingestion and stay in sync with provider updates.
Read the Webhooks documentation →
Querying Data
Retrieve user health data using flexible query options tailored to your application’s needs. Choose the right query method for statistics, sleep, workouts, samples, or provider records.