Inizia

Installa il pacchetto
- npm
- pnpm
- yarn
- bun
Terminal window
npm i @capgo/capacitor-native-biometric
Terminal window
pnpm add @capgo/capacitor-native-biometric
Terminal window
yarn add @capgo/capacitor-native-biometric
Terminal window
bun add @capgo/capacitor-native-biometric
Sincronizza con i progetti nativi
- npm
- pnpm
- yarn
- bun
Terminal window
npx cap sync
Terminal window
pnpm cap sync
Terminal window
yarn cap sync
Terminal window
bunx cap sync
Configura i permessi

iOS
Section titled “iOS”

Aggiungi la descrizione dell’uso di Face ID al tuo Info.plist:
```
<key>NSFaceIDUsageDescription</key>
<string>For secure authentication</string>
```
Android
Section titled “Android”

Aggiungi il permesso biometrico al tuo AndroidManifest.xml:
```
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
```

Utilizzo

Importa il plugin e usa i suoi metodi per l’autenticazione biometrica:

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

// Controlla se l'autenticazione biometrica è disponibile
const checkBiometric = async () => {
  const result = await NativeBiometric.isAvailable();

  if (result.isAvailable) {
    console.log(`Tipo biometrico: ${result.biometryType}`);
  }
};

// Esegui la verifica biometrica
const verify = async () => {
  const verified = await NativeBiometric.verifyIdentity({
    reason: "Per un accesso sicuro al tuo account",
    title: "Autenticazione",
    subtitle: "Verifica la tua identità",
    description: "Posiziona il dito sul sensore"
  })
    .then(() => true)
    .catch(() => false);

  if (verified) {
    console.log("Autenticazione riuscita");
  }
};

// Memorizza le credenziali in modo sicuro
const saveCredentials = async () => {
  await NativeBiometric.setCredentials({
    username: "user@example.com",
    password: "securepassword",
    server: "https://api.example.com"
  });
};

// Recupera le credenziali memorizzate
const getCredentials = async () => {
  const credentials = await NativeBiometric.getCredentials({
    server: "https://api.example.com"
  });

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

// Elimina le credenziali memorizzate
const deleteCredentials = async () => {
  await NativeBiometric.deleteCredentials({
    server: "https://api.example.com"
  });
};

Riferimento API

isAvailable()

Controlla se l’autenticazione biometrica è disponibile sul 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(options)

Esegue l’autenticazione biometrica.

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

setCredentials(options)

Memorizza le credenziali in modo sicuro con protezione biometrica.

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

getCredentials(options)

Recupera le credenziali memorizzate dopo l’autenticazione biometrica.

interface GetCredentialOptions {
  server: string;
}

deleteCredentials(options)

Elimina le credenziali memorizzate.

interface DeleteCredentialOptions {
  server: string;
}

Best practice

Controlla sempre la disponibilità per prima

const result = await NativeBiometric.isAvailable();
if (!result.isAvailable) {
  // Torna all'autenticazione tramite password
}

Fornisci motivi chiari Spiega sempre perché hai bisogno dell’autenticazione biometrica per creare fiducia nell’utente.

Gestisci gli errori con grazia

try {
  await NativeBiometric.verifyIdentity({
    reason: "Accedi ai tuoi dati sicuri"
  });
} catch (error) {
  // Gestisci annullamento o fallimento
  console.log("Autenticazione fallita o annullata");
}

Usa fallback appropriati Abilita il fallback del codice di accesso per i dispositivi in cui la biometria potrebbe fallire.