Erste Schritte

Installieren Sie das Paket
- npm
- pnpm
- yarn
- bun
Terminal-Fenster
npm i @capgo/capacitor-native-biometric
Terminal-Fenster
pnpm add @capgo/capacitor-native-biometric
Terminal-Fenster
yarn add @capgo/capacitor-native-biometric
Terminal-Fenster
bun add @capgo/capacitor-native-biometric
Synchronisieren Sie mit nativen Projekten
- npm
- pnpm
- yarn
- bun
Terminal-Fenster
npx cap sync
Terminal-Fenster
pnpm cap sync
Terminal-Fenster
yarn cap sync
Terminal-Fenster
bunx cap sync
Berechtigungen konfigurieren

iOS
Section titled “iOS”

Fügen Sie die Face ID-Nutzungsbeschreibung zu Ihrer Info.plist hinzu:
```
<key>NSFaceIDUsageDescription</key>
<string>For secure authentication</string>
```
Android
Section titled “Android”

Fügen Sie die biometrische Berechtigung zu Ihrer AndroidManifest.xml hinzu:
```
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
```

Verwendung

Importieren Sie das Plugin und verwenden Sie seine Methoden für biometrische Authentifizierung:

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

// Überprüfen, ob biometrische Authentifizierung verfügbar ist
const checkBiometric = async () => {
  const result = await NativeBiometric.isAvailable();

  if (result.isAvailable) {
    console.log(`Biometrischer Typ: ${result.biometryType}`);
  }
};

// Biometrische Verifizierung durchführen
const verify = async () => {
  const verified = await NativeBiometric.verifyIdentity({
    reason: "Für sicheren Zugriff auf Ihr Konto",
    title: "Authentifizierung",
    subtitle: "Verifizieren Sie Ihre Identität",
    description: "Legen Sie Ihren Finger auf den Sensor"
  })
    .then(() => true)
    .catch(() => false);

  if (verified) {
    console.log("Authentifizierung erfolgreich");
  }
};

// Anmeldedaten sicher speichern
const saveCredentials = async () => {
  await NativeBiometric.setCredentials({
    username: "user@example.com",
    password: "securepassword",
    server: "https://api.example.com"
  });
};

// Gespeicherte Anmeldedaten abrufen
const getCredentials = async () => {
  const credentials = await NativeBiometric.getCredentials({
    server: "https://api.example.com"
  });

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

// Gespeicherte Anmeldedaten löschen
const deleteCredentials = async () => {
  await NativeBiometric.deleteCredentials({
    server: "https://api.example.com"
  });
};

API-Referenz

isAvailable()

Überprüft, ob biometrische Authentifizierung auf dem Gerät verfügbar ist.

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)

Führt biometrische Authentifizierung durch.

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

setCredentials(options)

Speichert Anmeldedaten sicher mit biometrischem Schutz.

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

getCredentials(options)

Ruft gespeicherte Anmeldedaten nach biometrischer Authentifizierung ab.

interface GetCredentialOptions {
  server: string;
}

deleteCredentials(options)

Löscht gespeicherte Anmeldedaten.

interface DeleteCredentialOptions {
  server: string;
}

Best Practices

Immer zuerst Verfügbarkeit prüfen

const result = await NativeBiometric.isAvailable();
if (!result.isAvailable) {
  // Auf Passwort-Authentifizierung zurückgreifen
}

Klare Gründe angeben Erklären Sie immer, warum Sie biometrische Authentifizierung benötigen, um Vertrauen aufzubauen.

Fehler elegant behandeln

try {
  await NativeBiometric.verifyIdentity({
    reason: "Zugriff auf Ihre sicheren Daten"
  });
} catch (error) {
  // Abbruch oder Fehler behandeln
  console.log("Authentifizierung fehlgeschlagen oder abgebrochen");
}

Geeignete Fallbacks verwenden Aktivieren Sie Passcode-Fallback für Geräte, bei denen die Biometrie fehlschlagen kann.