Introduction
Once you have credentials on the Spike developer console you can begin using Spike API.
For a user to establish connection to Spike authentication must be done. Application user ID should be be constant throughout entire user lifecycle. User requires no pre-registration and will be valid from the moment of first provider integration is authorized.
Required parameters
application_id (int) application_id is constant and can be found on your console after login. It's unique identifyer of your application.
application_user_id (string) id you have selected to uniquely identify user on your own system, for e.g. "my_application_user_123".
signature (string) signature generated per each user using HMAC.
API Integration Initialization To connect users with data providers, first make an API call to get a redirect URL. Then redirect users to this URL to start the OAuth integration process.
API Endpoint:
Provider slug is a canonical name of a provider, eg: fitbit, garmin, huawei, oura, etc
Query parameters:
- redirect_uri (string, url): Optional URL to redirect the user back to after the integration is complete. Must be a whitelisted domain for your application.
- state (string): Optional state parameter that will be passed back to your redirect_uri. Can be used to maintain state between the request and callback.
So to get back an integration URL for garmin you would make the following call
which returns:
You can then redirect the user to path which would initiate the integration process
Below you can find
user_id (string) Key returned by Spike connect device request. This key should be stored in your database against the user and used for all interactions with the Spike API.
from (date) Query data from time. Format: 2025-01-02 or 2025-01-02T15:04:05
to (date) Query data to time. Format: 2025-01-02 or 2025-01-02T15:04:05
timezone (string) The timezone to use for responses, it would convert the original timestamp to this timezone; to avoid conversion and keep original user's timezone provide "local"