Getting Started

Salin 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 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:

Instal 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;

Instal shim selama bootstrap

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 oleh pengaturan plugin

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

origin: asal HTTPS utama host yang dipakai oleh shim dan API secara langsung
domains: nama host tambahan yang dipakai untuk memperbaiki pengaturan asli selama sinkronisasi
autoShim: default ke true dan mengontrol pengaturan asli 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
Android: asset_statements metadata dan sumber daya yang dihasilkan yang digunakan oleh manifest

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

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

Panduan platform

Pengaturan iOS

Domain dan Asosiasi 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 Getting Started untuk merencanakan autentikasi dan alur akun, hubungkannya dengan Menggunakan @capgo/capacitor-passkey untuk kemampuan asli di Menggunakan @capgo/capacitor-passkey, capgo/capacitor-login sosial untuk detail implementasi di capgo/capacitor-login sosial, capgo/capacitor-passkey untuk detail implementasi di capgo/capacitor-passkey, capgo/capacitor-biometrik native untuk detail implementasi di capgo/capacitor-biometrik native, dan Autentikasi dua faktor untuk detail implementasi di Autentikasi dua faktor.