Memulai

Instal paket
- 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
Sinkronkan dengan proyek asli
- npm
- pnpm
- yarn
- bun
Terminal window
npx cap sync
Terminal window
pnpm cap sync
Terminal window
yarn cap sync
Terminal window
bunx cap sync
Konfigurasikan izin

iOS
Section titled “iOS”

Tambahkan deskripsi penggunaan Face ID ke Info.plist Anda:
```
<key>NSFaceIDUsageDescription</key>
<string>For secure authentication</string>
```
Android
Section titled “Android”

Tambahkan izin biometrik ke AndroidManifest.xml Anda:
```
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
```

Penggunaan

Impor plugin dan gunakan metodenya untuk autentikasi biometrik:

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

// Periksa apakah autentikasi biometrik tersedia
const checkBiometric = async () => {
  const result = await NativeBiometric.isAvailable();

  if (result.isAvailable) {
    console.log(`Biometric type: ${result.biometryType}`);
  }
};

// Lakukan verifikasi biometrik
const verify = async () => {
  const verified = await NativeBiometric.verifyIdentity({
    reason: "For secure access to your account",
    title: "Authentication",
    subtitle: "Verify your identity",
    description: "Place your finger on the sensor"
  })
    .then(() => true)
    .catch(() => false);

  if (verified) {
    console.log("Authentication successful");
  }
};

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

// Ambil kredensial yang disimpan
const getCredentials = async () => {
  const credentials = await NativeBiometric.getCredentials({
    server: "https://api.example.com"
  });

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

// Hapus kredensial yang disimpan
const deleteCredentials = async () => {
  await NativeBiometric.deleteCredentials({
    server: "https://api.example.com"
  });
};

Referensi API

isAvailable()

Memeriksa apakah autentikasi biometrik tersedia di perangkat.

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)

Melakukan autentikasi biometrik.

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

setCredentials(options)

Menyimpan kredensial dengan aman dengan perlindungan biometrik.

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

getCredentials(options)

Mengambil kredensial yang disimpan setelah autentikasi biometrik.

interface GetCredentialOptions {
  server: string;
}

deleteCredentials(options)

Menghapus kredensial yang disimpan.

interface DeleteCredentialOptions {
  server: string;
}

Praktik Terbaik

Selalu periksa ketersediaan terlebih dahulu

const result = await NativeBiometric.isAvailable();
if (!result.isAvailable) {
  // Gunakan autentikasi password sebagai cadangan
}

Berikan alasan yang jelas Selalu jelaskan mengapa Anda memerlukan autentikasi biometrik untuk membangun kepercayaan pengguna.

Tangani kesalahan dengan baik

try {
  await NativeBiometric.verifyIdentity({
    reason: "Access your secure data"
  });
} catch (error) {
  // Tangani pembatalan atau kegagalan
  console.log("Authentication failed or cancelled");
}

Gunakan cadangan yang sesuai Aktifkan cadangan kode sandi untuk perangkat yang biometriknya mungkin gagal.