Getting Started

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce 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

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous.

Installer le package
Fenêtre de terminal
```
bun add @capgo/capacitor-passkey
```
Synchroniser les projets natifs
Fenêtre de terminal
```
bunx cap sync
```

Ajouter la configuration du 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;

Installer le shim lors du démarrage

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

await CapacitorPasskey.autoShimWebAuthn();

Conservez votre flux WebAuthn normal

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

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

Ce que fait la configuration du plugin

La configuration est lue à partir de plugins.CapacitorPasskey dans capacitor.config.*.

origin: origine HTTPS primaire utilisée par le shim et directement API
domains: ajouter des hôtes de tiers pour les synchroniser avec la configuration native
autoShim: par défaut true et contrôle la mise à jour native cap sync l'hook de configuration native automatique

Quels correctifs de synchronisation vous patchent

Lorsque vous exécutez bunx cap sync, le plugin met à jour le projet de hôte natif généré :

iOS : autorisations de domaine associées et mise en branchements Xcode lorsqu'il le faut
Android : asset_statements méta-données et le ressource généré utilisé par le manifeste

Votre site n'est pas hébergé par défaut. Vous devez l'héberger vous-même.

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

Guides de plateforme

Configuration iOS

Domaines associés et apple-app-site-association.

Configuration Android

Liens d'actif numérique et assetlinks.json.

Notes sur l'arrière-plan

Validation d'origine et les avertissements Android.

Continuez de Getting Started

Si vous utilisez Prise en main pour planifier l'authentification et les flux de compte, connectez-l’avec Utilisation de @capgo/capacitor-passkey pour la capacité native dans Utilisation de @capgo/capacitor-passkey @capgo/capacitor-connexion-social pour le détail d'implémentation dans @capgo/capacitor-social-login @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey @capgo/capacitor-native-biometrique pour le détail d'implémentation dans @capgo/capacitor-native-biometric, et Authentification à deux facteurs pour le détail d'implémentation dans Authentification à deux facteurs.