Mobile SDK
Flutter

Spike Flutter SDK is a library on top of HealthKit that 
helps with the extraction of data.
pushes data to SpikeAPI and delivers standardized data.
Requirements
iOS 13.0+
Xcode 13.0+
﻿Health Kit Reporter 2.1.0+
﻿Background fetch 1.0.3+

Signing & Capabilities
Go to your target's Signing & Capabilities section and add HealthKit. 
Allow Clinical Health Records, Background fetch, and Background Delivery.
﻿
More details you can find here.
Info.plist
Add Health Kit permissions descriptions to your Info.plist file.
Info.plist
|
<key>NSHealthShareUsageDescription</key>
<string>We will use your health information to better track workouts.</string>

<key>NSHealthUpdateUsageDescription</key>
<string>We will update your health information to better track workouts.</string>

<key>NSHealthClinicalHealthRecordsShareUsageDescription</key>
<string>We will use your health information to better track  workouts.</string>

...
<key>UIBackgroundModes</key>
<array>
    <string>fetch</string>
</array>
...

<key>NSHealthShareUsageDescription</key>
<string>We will use your health information to better track workouts.</string>

<key>NSHealthUpdateUsageDescription</key>
<string>We will update your health information to better track workouts.</string>

<key>NSHealthClinicalHealthRecordsShareUsageDescription</key>
<string>We will use your health information to better track  workouts.</string>

...
<key>UIBackgroundModes</key>
<array>
    <string>fetch</string>
</array>
...
﻿
Installation
You can download the Flutter SDK here. Please import the following libraries to your code:
Dart
|
import 'package:spike_flutter_sdk/spike_api.dart';
import 'package:spike_flutter_sdk/health_kit_reporting.dart';
import 'package:spike_flutter_sdk/model/health_data/activity_data.dart';
import 'package:spike_flutter_sdk/model/health_data/data_request.dart';
import 'package:spike_flutter_sdk/model/health_data/data_response.dart';
import 'package:spike_flutter_sdk/model/origin.dart';
import 'package:spike_flutter_sdk/spike_api.dart';
import 'package:spike_flutter_sdk/health_kit_reporting.dart';
import 'package:spike_flutter_sdk/model/health_data/activity_data.dart';
import 'package:spike_flutter_sdk/model/health_data/data_request.dart';
import 'package:spike_flutter_sdk/model/health_data/data_response.dart';
import 'package:spike_flutter_sdk/model/origin.dart';
﻿
Configuration
To set up Flutter SDK please provide the user ID, client ID, and auth token. You can find tokens on the Spike developer console. Typically _userId will be a user ID from your application. Personal identifiable information should not be used in the _userId.
Dart
|
// Your API credentials
const _authToken = 'fa0b3803-1111-2222-9788-eccce210d30c';
const _clientId = 'ea9e03f5-2222-49fb-3333-47a88c184c3b';
const _host = 'https://api.spikeapi.com';
const _callbackUrl = 'https://my_server.com/webhooks'; // Configurable by the client.
const _userId = 'jasbdhasbfashfj';

// Origin of the endpoint you are going to sync the data with
const _origin = Origin(
  host: _host,
  userId: _userId,
);

// API to read the data from Apple HealthKit
final _reporting = HealthKitReporting();

const _api = SpikeApi(origin: _origin);

/*
*  Requesting authorization.
*/
await _reporting.requestReadAuthorization();

/*
*  Initializing user integration.
*/
final integrationResult = await _api.initIntegration(
  authToken: _authToken,
  clientId: _clientId,
);

// Your API credentials
const _authToken = 'fa0b3803-1111-2222-9788-eccce210d30c';
const _clientId = 'ea9e03f5-2222-49fb-3333-47a88c184c3b';
const _host = 'https://api.spikeapi.com';
const _callbackUrl = 'https://my_server.com/webhooks'; // Configurable by the client.
const _userId = 'jasbdhasbfashfj';

// Origin of the endpoint you are going to sync the data with
const _origin = Origin(
  host: _host,
  userId: _userId,
);

// API to read the data from Apple HealthKit
final _reporting = HealthKitReporting();

const _api = SpikeApi(origin: _origin);

/*
*  Requesting authorization.
*/
await _reporting.requestReadAuthorization();

/*
*  Initializing user integration.
*/
final integrationResult = await _api.initIntegration(
  authToken: _authToken,
  clientId: _clientId,
);
﻿
Getting Data
 Reading Apple HealthKit data
Dart
|
/*
*  Reading Apple HealthKit data
*/
final appleSummariesData = await _reporting.readActivitiesSummaryData(
  from: DateTime(2022, 09, 22),
  to: DateTime.now(),
);

/*
*  Sending Apple HealthKit data to your backend.
*/
await _api.sendData(
  authToken: _authToken,
  request: DataRequest(
    records: appleSummariesData,
    userId: integrationResult.userId,
    callBackUrl: _callbackUrl,
  ),
);

final workoutRecords = await _reporting.readWorkouts(
  from: DateTime(2022, 09, 22),
  to: DateTime.now(),
);

/*
* Sending Apple HealthKit workouts data to your backend.
*/
await _api.sendWorkoutsData(
  authToken: _authToken,
  request: WorkoutsDataRequest(
    workouts: WorkoutsData.fromWorkoutRecords(workoutRecords),
    userId: integrationResult.userId,
    callBackUrl: _callbackUrl,
  ),
);

/*
*  Reading Apple HealthKit data
*/
final appleSummariesData = await _reporting.readActivitiesSummaryData(
  from: DateTime(2022, 09, 22),
  to: DateTime.now(),
);

/*
*  Sending Apple HealthKit data to your backend.
*/
await _api.sendData(
  authToken: _authToken,
  request: DataRequest(
    records: appleSummariesData,
    userId: integrationResult.userId,
    callBackUrl: _callbackUrl,
  ),
);

final workoutRecords = await _reporting.readWorkouts(
  from: DateTime(2022, 09, 22),
  to: DateTime.now(),
);

/*
* Sending Apple HealthKit workouts data to your backend.
*/
await _api.sendWorkoutsData(
  authToken: _authToken,
  request: WorkoutsDataRequest(
    workouts: WorkoutsData.fromWorkoutRecords(workoutRecords),
    userId: integrationResult.userId,
    callBackUrl: _callbackUrl,
  ),
);
﻿
Background data updates
SpikeTaskRunner enables background tasks to send data to the backend periodically.
Dart
|

SpikeTaskRunner.registerTask({
  origin: _origin,
  clientId: _clientId,
  authToken: _authToken,
  callbackUrl: _callbackUrl,
});

SpikeTaskRunner.registerTask({
  origin: _origin,
  clientId: _clientId,
  authToken: _authToken,
  callbackUrl: _callbackUrl,
});
﻿
﻿
Did this page help you?
TABLE OF CONTENTS
Requirements
Signing & Capabilities
Background data updates