Integration topic

Integration

This page summarizes what the consuming Flutter application must provide before calling the SmartFace APIs.

PT-BR

Esta página resume o que a aplicação Flutter consumidora precisa disponibilizar antes de chamar as APIs do SmartFace.

Language guide

English is the primary language of this page.

PT-BR: os blocos marcados com este rótulo destacam a mesma orientação em português do Brasil.

Platform Prerequisites

Android

• Provide the SmartFace .aar distributed for your client installation.
• Make the binary available from the consumer application's android/libs directory.
• Ensure the Gradle configuration exposes that path to the plugin.
• Declare camera and network permissions in the Android app.

iOS

• Provide SmartfaceMobile.xcframework, SmartfaceMobileUIKit.xcframework, and sface.xcframework.
• Place the frameworks in the expected SmartFace SDK directory of the consumer app.
• Add them to the application target with Embed & Sign.
• Declare NSCameraUsageDescription in the host application.

Public Libraries And Their Roles

• flutter_smartface_license: license login, product discovery, install state.
• flutter_smartface_mobile: main Flutter-facing biometric API, widgets, data sync, and credential setup.
• flutter_smartface_hosted_flow: native hosted identification and enrollment flows.
• flutter_smartface_enroller: descriptor-oriented enrollment without immediate server push.
• flutter_smartface_base: shared method-channel and PlatformView infrastructure.

Minimal App Startup Sequence

1. Finish native binary setup.
2. Authenticate the license user with FlutterSmartfaceLicensePlatform.setLogin.
3. Install the correct product with FlutterSmartfaceLicensePlatform.install.
4. Configure biometric API credentials with FlutterSmartfaceMobilePlatform.setCredentials.
5. Optionally restore the session on app startup with FlutterSmartfaceMobilePlatform.apiConfigured.

Integrator Notes

• apiConfigured() is the preferred startup check because it restores saved credentials and reapplies persisted group keys.
• fetchAllFromServer() also reapplies persisted groupKeyA and groupKeyB before delegating to the native layer, which helps after app restarts when the AAR no longer has the in-memory filter state.
• fetchFromServer() follows the same group rehydration path before the native sync call.
• Do not rely on addGroupKeyA(0) or addGroupKeyB(0) to clear scope; use clearGroupKeyA() and clearGroupKeyB() instead.
• Hosted flows are simpler to integrate, while widget APIs are better when the Flutter app must own the surrounding layout.
• The example app in this repository is the best validated end-to-end reference for production wiring.

PT-BR

Para integradores: prefira apiConfigured() na subida do app, use hosted flow quando quiser menos composição manual e use o app de exemplo como referência de integração validada.

Libraries

flutter_smartface_base

Core building blocks shared by the public SmartFace Flutter APIs.

flutter_smartface_mobile

Main SmartFace Flutter API for biometric operations.