website·Indexed 32 days ago
https://docs.gofa.coDeveloper platform for hosted health experiences, providing server-to-server APIs and Flutter SDKs. Includes documentation for the Vital Scan API, Avatar API, and various AI services for nutrition, training, movement, water intake, and wellness chat, as well as Activities APIs for managing exercise catalogues, lessons, and challenges.
The Activities APIs allow developers to interact with GOFA's hosted exercise catalogues and user play records. The available integration surfaces include:
Note: CMS authoring, B2B administration, and content mutations are not available via these APIs.
GOFA provides different authentication mechanisms depending on the integration type. While the Commercial API uses a server-side Authorization: Bearer <GOFA_API_KEY> header, client-integration routes under /api/client and /api/auth require specific credential types.
Available authentication flows include:
ClientToken.Before building an integration, ensure account registration is complete on the GOFA website and confirm client provisioning, module entitlement, and environment details with GOFA.
flutter pub add get_it
flutter pub add provider
flutter pub add bloc
flutter pub add flutter_blocupdateCallback function, which sends objects containing a type (the event name) and data (the payload). The module covers assessment surveys, physical assessments, pain reviews, and report generation.GOFA AI provides several specialized modules for user-facing applications:
LessonStartedData and LessonFinishedData provide detailed context about the lesson, play, and plan associated with the event. They extend EventData and include identifiers and object references for the lesson and plan.class LessonStartedData extends EventData {
final String lessonId;
final Lesson? lesson;
final String playId;
final Play play;
final String? planId;
final Plan? plan;
final String? planPlayId;
final PlanPlay? planPlay;
LessonStartedData({
required String? clientUserId,
required this.lessonId,
required this.lesson,
required this.playId,
required this.play,
required this.planId,
required this.plan,
required this.planPlayId,
required this.planPlay,
}) : super(clientUserId: clientUserId);
@override
Map<String, dynamic> toJson() {
return {
'clientUserId': clientUserId,
'lessonId': lessonId,
'lesson': lesson?.toJson(),
'playId': playId,
'play': play.toJson(),
'planId': planId,
'plan': plan?.toJson(),
'planPlayId': planPlayId,
'planPlay': planPlay?.toJson(),
};
}
}
// LessonFinishedData has an identical structure to LessonStartedDataThe Vital Scan API follows a server-to-server workflow to conduct hosted user assessments:
vitalScanUrl to the user's browser or a mobile WebView.vitalScanResultId until a terminal status (completed, failed, or expired) is reached.Constraint: Inline <iframe> embedding is not supported.
/msk/*) use Firebase custom token authentication. The Flutter WebView SDK obtains a short-lived (1 hour) custom token and passes it via a URL parameter (?customToken=xxx) on the first page load. The server then exchanges this token for a secure, HttpOnly session cookie, which is used for all subsequent navigations. To ensure security and isolation, the server validates that the token matches the client subdomain (e.g., https://{clientId}.gofa.app/msk/*).The Avatar API accepts a face image and returns a temporary URL for a generated avatar sheet, the sheet dimensions, and crop rectangles for four views (front, right three-quarter, right profile, and back). Optionally, it can return these views as separate base64 strings.
Endpoint: POST /api/avatar (called on your assigned GOFA client domain).
GOFA provides three primary Flutter packages distributed via OnePub. Choose the package based on the required integration:
gofa_pose: Used for motion tracking, exercise challenges, and repetition counting.gofa_lessons: Used for fitness lessons, training plans, and playback events.gofa_webview: Used to embed GOFA web experiences within a Flutter application.To install these packages, use the organization access provided by GOFA as specified in the respective package installation guides.