Panduan Memulai

Salin prompt setup yang berisi langkah install 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.

Instalasi

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command 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 memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

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

Install shim saat bootstrap

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

await CapacitorPasskey.autoShimWebAuthn();

Tetap gunakan alur WebAuthn normal Anda

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

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

Apa fungsi konfigurasi plugin

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

origin: origin relying-party HTTPS utama yang digunakan oleh shim dan API langsung
domains: hostname relying-party tambahan untuk di-patch ke config native saat sync
autoShim: defaultnya adalah true dan mengontrol native cap sync hook auto-konfigurasi

Apa yang di-patch sync untuk Anda

Saat Anda menjalankan bunx cap sync, plugin akan memperbarui proyek native host yang dihasilkan:

iOS: entitlements associated domains dan pengaturan Xcode entitlements jika diperlukan
Android: asset_statements metadata dan resource yang dihasilkan untuk manifest

Hook ini tidak memublikasikan file trust website Anda secara otomatis. Anda tetap perlu menghosting:

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

Contoh: JSON API langsung (tanpa shim)

Jika backend Anda sudah mengembalikan WebAuthn JSON, panggil metode plugin secara langsung.

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

const registration = await CapacitorPasskey.createCredential({
  publicKey: registrationOptionsFromServer,
});

const assertion = await CapacitorPasskey.getCredential({
  publicKey: requestOptionsFromServer,
});

Gunakan isSupported() sebelum menampilkan UI passkey pada perangkat lama.

Panduan platform

Setup iOS

Associated Domains dan apple-app-site-association.

Setup Android

Digital Asset Links dan assetlinks.json.

Catatan backend

Validasi origin dan catatan penting Android.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan alur autentikasi dan akun, hubungkan dengan Menggunakan @capgo/capacitor-passkey untuk kapabilitas native saat 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.