Guía
Cómo usar Biométrico Nativo en Capacitor
Probar en dispositivo
Descargue la aplicación Capgo y escane el código QR code.
Usando @capgo/capacitor-biometría-nativa
Este plugin proporciona acceso a las API de biometría nativa para Android e iOS.
Instalar
bun add @capgo/capacitor-native-biometric
bunx cap sync
bunx cap sync copia el plugin de code nativo en tus proyectos nativos. Correlo de nuevo después de cada actualización del plugin.
Importar
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
Vista general de API
| Método | Descripción |
|---|---|
isAvailable |
Verifica si el hardware de autenticación biométrica está disponible. |
verifyIdentity |
Pide al usuario que se autentique con biométricas. |
getCredentials |
Obtiene las credenciales almacenadas para un servidor dado. |
setCredentials |
Almacena las credenciales dadas para un servidor dado. |
deleteCredentials |
Elimina las credenciales almacenadas para un servidor dado. |
getSecureCredentials |
Obtiene las credenciales almacenadas para un servidor dado, requiriendo autenticación biométrica. Las credenciales deben haberse almacenado con accessControl establecido en BIOMETRY_CURRENT_SET o BIOMETRY_ANY. |
isCredentialsSaved |
Verifica si las credenciales ya están guardadas para un servidor dado. |
setData |
Almacena un valor de cadena arbitrario bajo la clave dada. Los valores se cifran en reposo utilizando el backend de almacenamiento seguro de la plataforma (Android Keystore + SharedPreferences, iOS Keychain). |
getData |
Obtiene un valor almacenado previamente para la clave dada. Solo devuelve valores almacenados sin biométrica accessControl. |
getSecureData |
Obtiene un valor protegido por biométrica para la clave dada. El valor debe haberse almacenado con accessControl set a BIOMETRY_CURRENT_SET o BIOMETRY_ANY. |
deleteData |
Elimina el valor almacenado para la clave dada (protegida y no protegida). |
isDataSaved |
Verifica si ya se ha guardado un valor para la clave dada. |
Ejemplos
isAvailable()
Verifica si el hardware de autenticación biométrica está disponible.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.isAvailable();
console.log(result);
verifyIdentity()
Solicita al usuario que se autentique con biometría.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.verifyIdentity();
getCredentials()
Verifica si el hardware de autenticación biométrica está disponible.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
setCredentials()
Indica al usuario que autentique con biométricas.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.setCredentials({
username: 'username',
password: 'password',
server: 'example.com',
});
deleteCredentials()
Obtiene las credenciales almacenadas para un servidor dado.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.deleteCredentials({ server: 'example.com' });
getSecureCredentials()
Gets the stored credentials for a given server, requiring biometric authentication. Credentials must have been stored with accessControl set to BIOMETRY_CURRENT_SET or BIOMETRY_ANY.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getSecureCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
La tabla anterior muestra los 12 métodos básicos. Los ayudantes de escucha y versión, así como el contrato completo de cada método, se documentan en repositorio de GitHub.
Escuchar eventos
addListener devuelve un manejador. Llame a handle.remove() cuando la pantalla se desmonta.
Referencia completa
Sigue adelante desde Usando @capgo/capacitor-native-biometric
Si estás utilizando Usando @capgo/capacitor-native-biometric para planificar la autenticación y los flujos de cuenta, conecta con @capgo/capacitor-native-biometric para los detalles de implementación en @capgo/capacitor-native-biometric, Getting Started para los detalles de implementación en Empezando @capgo/capacitor-login social para los detalles de implementación en @capgo/capacitor-login social @capgo/capacitor-clave de acceso para los detalles de implementación en @capgo/capacitor-clave de acceso, y Autenticación en dos factores para los detalles de implementación en Autenticación en dos factores.