Architecture Overview

There are two scenarios for how to integrate with us.

Default integration path

GeroSense API assumes server-to-server communication, which usually involves three main elements:

  • Your client application is something that your users interact with. Usually, a mobile app that has access to users' health data via Apple HealthKit, Health Connect, or any other health data provider.

  • Your API server is a backend that acts as a proxy between your client application and the GeroSense API. Its responsibilities include authenticating users, sending their health data to GeroSense API, and receiving and caching results from it.

  • GeroSense API is an API service that we provide to calculate users' health metrics like biological age and resilience based on their longitudinal health data, like a history of steps or heart rate measurements. To send requests to the GeroSense API, you must get authentication credentials from us.

Read GeroSense API Reference if you prefer this option.

Integrate via Docker image instead of updating your API

If you use JWT-based authentication, there is a simplified integration path. Instead of updating your API server, you can host our premade Docker image as a proxy. It will confirm your users' identity and handle token-based authentications with our API. In this case, you only need to update your mobile application to work directly with the proxy.

If you use third-party authentication services like Firebase or Supabase, this is a recommended way of integrating with us.

Read GeroSense API Proxy Reference if you prefer this option.

Last updated