Getting Started

Copy sebuah 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.

Pemasangan

Anda dapat menggunakan Setup Bantuan AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-passkey` plugin in my project.

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

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 bootstrap

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

await CapacitorPasskey.autoShimWebAuthn();

Tetapkan alur WebAuthn normal

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.*.

originAsal HTTPS utama yang digunakan oleh shim dan API secara langsung
domainsNama domain tambahan untuk dipasang ke konfigurasi native selama sinkronisasi
autoShimberdasarkan pada true dan mengontrol pengaturan native cap sync Hook konfigurasi native otomatis

Apa yang disinkronisasi untuk Anda

Saat Anda menjalankan bunx cap syncplugin ini memperbarui proyek host native yang dihasilkan:

iOS: pengaturan domain terkait dan pengaturan Xcode untuk menghubungkan kapan saja
Android: asset_statements metadata dan sumber daya yang dihasilkan yang digunakan oleh manifest

Hook tidak memublikasikan file kepercayaan situs web Anda untuk Anda. Anda masih perlu menyiapkan:

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

Petunjuk Platform

Pengaturan iOS

Domain yang Dikaitkan dan apple-app-site-association.

Pengaturan Android

Tautan Aset Digital dan assetlinks.json.

Catatan Backend

Validasi Asal dan Keterbatasan Android.

Lanjutkan dari Getting Started

Jika Anda menggunakan Mulai Membuka Portal untuk merencanakan autentikasi dan alur akun, hubungkannya dengan Menggunakan @capgo/capacitor-passkey untuk kemampuan asli dalam Menggunakan @capgo/capacitor-passkey, @capgo/capacitor-social-login untuk detail implementasi dalam @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi dalam @capgo/capacitor-passkey, @capgo/capacitor-native-biometric untuk detail implementasi dalam @capgo/capacitor-native-biometric, dan Dua-Faktor Autentikasi untuk detail implementasi dalam Dua-Faktor Autentikasi.