Getting Started

GitHub

Kopieren Sie einen Setup-Vorschlag mit den Installationsanweisungen und dem vollständigen Markdown-Leitfaden für diesen Plugin.

        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.

Installation

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Anwendung mit dem folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunter angegebenen Plattform-spezifischen Anweisungen befolgen:

Installieren Sie das Paket
Terminalfenster
```
bun add @capgo/capacitor-passkey
```
Synchronisieren Sie native Projekte
Terminalfenster
```
bunx cap sync
```

Fügen Sie die Plugin-Konfiguration hinzu

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;

Installieren Sie den Shim während des Bootstraps

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

await CapacitorPasskey.autoShimWebAuthn();

Behalten Sie Ihren normalen WebAuthn-Fluss bei

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

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

Was die Plugin-Konfiguration tut

Die Konfiguration wird aus plugins.CapacitorPasskey in capacitor.config.*.

origin: Haupt-HTTPS-Vertrauenspartner-URL, die vom Shim und direkt verwendet wird API
domainsFügen Sie zusätzliche Relying-Party-Hostname zur nativen Konfiguration während der Synchronisierung ein.
autoShim: standardmäßig true und steuert die native cap sync Auto-Konfigurations-Hook

Was synchronisiert Patches für Sie

Wenn Sie es ausführen bunx cap sync, aktualisiert das Plugin den generierten native Host-Projekt:

iOS: Berechtigungen für assoziierte Domains und Xcode-Berechtigungen werden wie erforderlich konfiguriert.
Android: asset_statements Metadaten und die generierte Ressource, die vom Manifest verwendet wird

Der Hook veröffentlicht Ihre Website-Trust-Dateien nicht für Sie. Sie müssen sie noch selbst hosten:

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

Plattform-Anleitungen

iOS-Einrichtung

Zugehörige Domains und apple-app-site-association.

Android-Einrichtung

Digitale Asset-Links und assetlinks.json.

Hinweise zum Backend

Origin-Validierung und Android-Hinweise.

Weitergehen von Getting Started

Wenn Sie die Getting Started zum Planen von Authentifizierungs- und Konto-Flüssen verwenden, verbinden Sie es mit Verwendung von @capgo/capacitor-passkey für die native Fähigkeit in Verwendung von @capgo/capacitor-Passkey, @capgo/capacitor-Social-Login für die Implementierungsdetails in @capgo/capacitor-Social-Login, @capgo/capacitor-Passkey für die Implementierungsdetails in @capgo/capacitor-Passkey, @capgo/capacitor-Native-Biometrik für die Implementierungsdetails in @capgo/capacitor-Native-Biometrik und Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung.