Menggunakan @capgo/capacitor-biometrik-asli
Plugin ini memberikan akses ke API biometrik asli untuk android dan iOS.
Pasang
bun add @capgo/capacitor-native-biometric
bunx cap sync
bunx cap sync Menggandakan plugin native code ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.
Import
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
API secara singkat
| Metode | Deskripsi |
|---|---|
isAvailable |
Mengatur apakah perangkat autentikasi biometrik tersedia. |
verifyIdentity |
Mengajak pengguna untuk mengautentikasi dengan biometrik. |
getCredentials |
Mengambil kreditensi yang disimpan untuk server tertentu. |
setCredentials |
Menyimpan kreditensi yang diberikan untuk server tertentu. |
deleteCredentials |
Menghapus kreditensi yang disimpan untuk server tertentu. |
getSecureCredentials |
Mengambil kreditensi yang disimpan untuk server tertentu, memerlukan autentikasi biometrik. Kreditensi harus disimpan dengan aksesControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY. |
isCredentialsSaved |
Mengatur apakah kreditensi sudah disimpan untuk server tertentu. |
setData |
Menyimpan nilai string apa pun di bawah kunci yang diberikan. Nilai-nilai disimpan dengan cara dienkripsi menggunakan backend penyimpanan yang aman (Android Keystore + SharedPreferences, iOS Keychain). |
getData |
Mengambil nilai yang telah disimpan sebelumnya untuk kunci yang diberikan. Hanya mengembalikan nilai-nilai yang disimpan tanpa biometrik. accessControl. |
getSecureData |
Mengambil nilai yang dilindungi biometrik untuk kunci yang diberikan. Nilai tersebut harus telah disimpan dengan accessControl Ditetapkan ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY. |
deleteData |
Menghapus nilai yang disimpan untuk kunci yang diberikan (lindungi dan tidak dilindungi). |
isDataSaved |
Mengatur apakah nilai sudah disimpan untuk kunci yang diberikan. |
Contoh
isAvailable()
Mengatur apakah perangkat autentikasi biometrik sudah tersedia.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.isAvailable();
console.log(result);
verifyIdentity()
Mengajak pengguna untuk melakukan autentikasi dengan biometrik.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.verifyIdentity();
getCredentials()
Mengambil kredit yang disimpan untuk server yang diberikan.
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()
Menyimpan kredit yang diberikan untuk server yang diberikan.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.setCredentials({
username: 'username',
password: 'password',
server: 'example.com',
});
deleteCredentials()
Menghapus kredit yang disimpan untuk server yang diberikan.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.deleteCredentials({ server: 'example.com' });
getSecureCredentials()
Mengambil kredit yang disimpan untuk server tertentu, memerlukan autentikasi biometrik. Kredit harus telah disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau 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.
Daftar tabel di atas mencantumkan 12 metode inti. Pembantu pendengar dan versi, serta kontrak penuh dari setiap metode, terdokumentasi di repository GitHub.
Dengarkan kejadian
addListener mengembalikan sebuah handle. Panggil handle.remove() ketika layar dihapus.
Referensi lengkap
Teruskan dari Menggunakan @capgo/capacitor-native-biometric
Jika Anda menggunakan Gunakan @capgo/capacitor-native-biometric untuk merencanakan alur autentikasi dan akun, hubungkannya dengan @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, Mulai Menggunakan untuk detail implementasi di Mulai, @capgo/capacitor-login Sosial untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, dan Autentikasi dua faktor untuk detail implementasi di Autentikasi dua faktor.