Comenzar

Instalar el paquete
- npm
- pnpm
- yarn
- bun
Ventana de terminal
npm i @Capgo/Capacitor-native-biometric
Ventana de terminal
pnpm add @Capgo/Capacitor-native-biometric
Ventana de terminal
yarn add @Capgo/Capacitor-native-biometric
Ventana de terminal
bun add @Capgo/Capacitor-native-biometric
Sincronizar con proyectos nativos
- npm
- pnpm
- yarn
- bun
Ventana de terminal
npx cap sync
Ventana de terminal
pnpm cap sync
Ventana de terminal
yarn cap sync
Ventana de terminal
bunx cap sync
Configurar permisos

iOS
Section titled “iOS”

Agrega la descripción de uso de Face ID a tu Info.plist:
```
<key>NSFaceIDUsageDescription</key>
<string>For secure authentication</string>
```
Android
Section titled “Android”

Agrega el permiso biométrico a tu AndroidManifest.xml:
```
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
```

Uso

Importa el Plugin y usa sus métodos para autenticación biométrica:

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

// Verificar si la autenticación biométrica está disponible
const checkBiometric = async () => {
  const result = await NativeBiometric.isAvailable();

  if (result.isAvailable) {
    console.log(`Tipo de biometría: ${result.biometryType}`);
  }
};

// Realizar verificación biométrica
const verify = async () => {
  const verified = await NativeBiometric.verifyIdentity({
    reason: "Para acceso seguro a tu cuenta",
    title: "Autenticación",
    subtitle: "Verifica tu identidad",
    description: "Coloca tu dedo en el sensor"
  })
    .then(() => true)
    .catch(() => false);

  if (verified) {
    console.log("Autenticación exitosa");
  }
};

// Almacenar credenciales de forma segura
const saveCredentials = async () => {
  await NativeBiometric.setCredentials({
    username: "user@example.com",
    password: "securepassword",
    server: "https://api.example.com"
  });
};

// Recuperar credenciales almacenadas
const getCredentials = async () => {
  const credentials = await NativeBiometric.getCredentials({
    server: "https://api.example.com"
  });

  console.log(credentials.username);
  console.log(credentials.password);
};

// Eliminar credenciales almacenadas
const deleteCredentials = async () => {
  await NativeBiometric.deleteCredentials({
    server: "https://api.example.com"
  });
};

Referencia de API

isAvailable()

Verifica si la autenticación biométrica está disponible en el dispositivo.

interface AvailableResult {
  isAvailable: boolean;
  biometryType?: BiometryType;
  errorCode?: number;
}

enum BiometryType {
  NONE = 0,
  TOUCH_ID = 1,
  FACE_ID = 2,
  FINGERPRINT = 3,
  FACE_AUTHENTICATION = 4,
  IRIS_AUTHENTICATION = 5
}

verifyIdentity(Opciones)

Realiza la autenticación biométrica.

interface BiometricOptions {
  reason?: string;
  title?: string;
  subtitle?: string;
  description?: string;
  fallbackTitle?: string;
  useFallback?: boolean;
  maxAttempts?: number;
}

setCredentials(Opciones)

Almacena credenciales de forma segura con protección biométrica.

interface Credentials {
  username: string;
  password: string;
  server: string;
}

getCredentials(Opciones)

Recupera credenciales almacenadas después de la autenticación biométrica.

interface GetCredentialOptions {
  server: string;
}

deleteCredentials(Opciones)

Elimina credenciales almacenadas.

interface DeleteCredentialOptions {
  server: string;
}

Mejores Prácticas

Siempre verificar disponibilidad primero

const result = await NativeBiometric.isAvailable();
if (!result.isAvailable) {
  // Volver a autenticación con contraseña
}

Proporcionar razones claras Siempre explica por qué necesitas autenticación biométrica para generar confianza en el usuario.

Manejar errores con gracia

try {
  await NativeBiometric.verifyIdentity({
    reason: "Acceder a tus datos seguros"
  });
} catch (error) {
  // Manejar cancelación o fallo
  console.log("Autenticación fallida o cancelada");
}

Usar alternativas apropiadas Habilita la alternativa de código de acceso para dispositivos donde la biometría puede fallar.