Getting Started

Copy prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-passkey`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/passkey/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Pasang paket
Jendela Terminal
```
bun add @capgo/capacitor-passkey
```
Sinkronkan proyek native
Jendela Terminal
```
bunx cap sync
```

Tambahkan konfigurasi plugin

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'app.capgo.passkey.example',
  appName: 'My App',
  webDir: 'dist',
  plugins: {
    CapacitorPasskey: {
      origin: 'https://signin.example.com',
      autoShim: true,
      domains: ['signin.example.com'],
    },
  },
};

export default config;

Pasang shim selama bootstrapping

import { CapacitorPasskey } from '@capgo/capacitor-passkey';

await CapacitorPasskey.autoShimWebAuthn();

Tetapkan alur WebAuthn normal Anda

const registration = await navigator.credentials.create({
  publicKey: registrationOptions,
});

const authentication = await navigator.credentials.get({
  publicKey: requestOptions,
});

Apa yang dilakukan konfigurasi plugin

Konfigurasi dibaca dari plugins.CapacitorPasskey di capacitor.config.*.

origin: asal HTTPS utama RP yang digunakan oleh shim dan langsung API
domains: hostname RP tambahan untuk memperbaiki ke konfigurasi native selama sinkronisasi
autoShimberlaku secara default true dan mengontrol aspek native cap sync hook konfigurasi otomatis

Apa saja patch sinkronisasi untuk Anda

Ketika Anda menjalankan bunx cap sync, plugin ini memperbarui proyek host native yang dihasilkan:

iOS: hak akses domain terkait dan pengaturan Xcode ketika diperlukan
Anda: asset_statements metadata dan sumber daya yang dihasilkan digunakan oleh manifest

Hook ini tidak memublikasikan file kepercayaan situs web Anda. Anda masih perlu menampung:

https://your-domain/.well-known/apple-app-site-association
https://your-domain/.well-known/assetlinks.json

Petunjuk platform

Pengaturan iOS

Domain-Asosiasi dan apple-app-site-association.

Pengaturan Android

Tautan Aset Digital dan assetlinks.json.

Catatan Backend

Validasi Asal dan Keterbatasan Android.

Teruskan dari Getting Started

Jika Anda menggunakan Pembuatan Awal untuk merencanakan autentikasi dan alur akun, hubungkannya dengan Menggunakan @capgo/capacitor-passkey untuk kemampuan asli di Menggunakan @capgo/capacitor-passkey, @capgo/capacitor-social-login untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, dan Autentikasi dua faktor untuk detail implementasi di Autentikasi dua faktor.