Integrating ROOK's SDKs is essential for accessing health data from mobile-based sources like Apple Health and Health Connect. This article will guide you through the process of testing and integrating the ROOK SDKs into your application.
Understanding ROOK SDKs
ROOK offers SDKs for various platforms, including iOS, Android, React Native, Flutter, and Capacitor.
These SDKs enable the extraction of health data directly from users' devices, supporting features like hourly step metrics and pre-existing data retrieval.
The SDKs work by extracting data, respecting source-specific limitations such as app states and device settings.
Data extracted via the SDKs is then sent to ROOK servers for processing and delivery.
Testing Your Integration
Before deploying your integration to production, testing is crucial to ensure a smooth and effective user experience. Here’s how you can test your SDK integration:
Sandbox Environment: Begin by integrating the SDK into your application within the ROOK sandbox environment. This allows you to test without affecting live users.
User Authorization: Implement the authorization flow using the SDK to enable users to grant access to their health data. For mobile-based sources, authorization is initiated via SDK popups.
Data Extraction: Ensure the SDK extracts data correctly and at the expected frequency. For example, step data should update hourly in the background. Verify that your app can retrieve pre-existing data (up to 29 days).
Data Delivery: Confirm that the extracted data is sent to ROOK servers.
Webhook Setup: Configure and test your Data Webhooks in the ROOK Portal to receive real-time data updates. Use a tool like Webhook.site to validate payloads.
Data Validation: Check the format and content of the delivered JSON data to ensure it matches the expected schemas. The JSON structure for events and summaries is consistent with the format used for daily data deliveries.
Key Integration Steps
Select the Appropriate SDK: Choose the SDK that matches your development platform: iOS, Android, React Native, Flutter, or Capacitor.
Install the SDK: Follow the installation instructions in the ROOK SDK documentation for your chosen platform.
Implement Authorization: Use the SDK’s functions to trigger authorization popups and obtain user consent to access health data.
Configure Data Extraction: Implement the logic to start data extraction via the SDK. Note that data is extracted in the background, respecting device and app settings.
Handle Data Delivery: Set up your application to receive data via webhooks, or use the ROOK API for on-demand queries.
Specific SDK Considerations
Capacitor SDK: The Capacitor SDK is developed in TypeScript but supports integration using both TypeScript and JavaScript.
iOS: Data is extracted from Apple Health.
Android: Data is extracted from Health Connect and the Android operating system.
Transitioning to Production
Request Production Enablement: Once testing is complete, contact ROOK Support to enable your production environment.
Configure Production Settings: Repeat the sandbox configuration steps for your production environment.
User Connections: Connect users to their health data sources via the SDK.
Live Data Monitoring: Monitor live data flow via webhooks, and use the ROOK API for specific queries.
Additional Resources
SDK Documentation: Refer to the specific documentation for your SDK for detailed integration instructions.
Data Delivery: Learn about webhooks and the ROOK API for data access.
Data Types: Understand the structure of delivered data.
By following these steps, you can effectively test and integrate ROOK SDKs into your application and leverage the power of health data for your users.