Quickstart

To get started with the Spike API first create an account, by signing up at https://spikeapi.com. Once approved you'll have access to the Spike developer console.

Once you have these credentials you can begin using Spike API.

Integration initialization

For a user to establish connections with data providers, applications need to launch the integration flow, which entails opening Spike's integration webpage on the user's browser.

Required parameters:

client_id (string) App ID for your team.

provider (string) name of the data provider.

user_id (string) A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information should not be used in the user_id.

Providers

*Please, use iOS SDK (Swift, React Native, Flutter, or Android-Kotlin) to connect to Apple Health and Android Health Connect.

URL Example

Integration Flow





Users will be redirected to a data provider website and users will be asked to submit authentication details. Once the user authorizes access to their data, Spike returns the user back to the application using the postback URL. (You can edit it on the developer console). Appended to the postback URL is the Spike user ID. Following is an example of the postback URL with the user ID highlighted:

https://my_test_app.com/callback?provider=fitbit&customer_user_id=00001c&user_id=fa1e3803-6068-4ea7-9788-eccce210d30c

Please save it and use it for all user data requests.

Get data from devices

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.

start_data (date) Date from in YYYY-MM-DD format

end_data (date) Date to in YYYY-MM-DD format

x-spike-auth (string) Application token from Spike console.

import requests

url = "https://api.spikeapi.com/metrics/calories/?user_id=282812818&start_date=2020-05-01&end_date=2020-05-03"
headers = {}
headers['x-spike-auth'] = 'fa0b3803-1111-2222-9788-eccce210d30c'
response = requests.request("GET", url, headers=headers)

print(response.text)