Getting Started

Instalación

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

1. Instalar el paquete

   bun add @capgo/capacitor-passkey

2. Sincronizar proyectos nativos

   bunx cap sync

3. Agregar la configuración del 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;

4. Instalar el shim durante el arranque

   import { CapacitorPasskey } from '@capgo/capacitor-passkey';
   
   await CapacitorPasskey.autoShimWebAuthn();

5. Mantén tu flujo WebAuthn normal

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

¿Qué hace la configuración del plugin?

La configuración se lee de plugins.CapacitorPasskey en capacitor.config.*.

• originOrigen HTTPS principal de confianza utilizado por el shim y el API directo
• domains: agregar hostnames de terceros para parchear en la configuración nativa durante la sincronización
• autoShim: predetermina a true y controla la pata de configuración nativa cap sync hook de configuración automática

¿Qué parches de sincronización te aplica?

Cuando ejecutas bunx cap sync, el plugin actualiza el proyecto de host nativo generado:

• iOS: permisos de dominio asociados y configuración de Xcode cuando sea necesario
• Android: asset_statements metadatos y el recurso generado utilizado por el manifiesto

El hook no publica los archivos de confianza de su sitio web por usted. Todavía necesita hospedar:

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

Guías de plataforma

iOS setup

Dominios asociados y apple-app-site-association.

Configuración de Android

Enlaces de activos digitales y assetlinks.json.

Notas de backend

Validación de origen y advertencias de Android.

Siga adelante desde Inicio

Si está utilizando Getting Started a planificar la autenticación y los flujos de cuenta, conectándolo con Usando @capgo/capacitor-passkey para la capacidad nativa en Usando @capgo/capacitor-passkey @capgo/capacitor-login-social para el detalle de implementación en @capgo/capacitor-social-login @capgo/capacitor-clave de paso para el detalle de implementación en @capgo/capacitor-passkey @capgo/capacitor-nativo-biometrio para el detalle de implementación en @capgo/capacitor-native-biometric, y Dos factores de autenticación para el detalle de implementación en Dos factores de autenticación.