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 utilice la siguiente solicitud:

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 complemento

   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. Mantenga su 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 desde plugins.CapacitorPasskey en capacitor.config.*.

• origin: origen de confianza HTTPS primario utilizado por el shim y directo API
• domains: nombres de host de confianza adicionales para parchear en la configuración nativa durante la sincronización
• autoShim: por defecto true y controla la configuración nativa cap sync de la función de ganchillo de configuración automática

¿Qué parches de sincronización para usted?

Cuando ejecutes bunx cap syncel plugin actualiza el proyecto de host nativo generado:

• iOS: permisos de dominios asociados y configuración de permisos 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 tu sitio web por ti. Todavía necesitas alojar:

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

Guías de plataforma

Configuración de iOS

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.

Sigue adelante desde Inicio

Si estás utilizando Inicio para planificar la autenticación y los flujos de cuenta, conecta con Usando @capgo/capacitor-passkey para la capacidad nativa en Usando @capgo/capacitor-passkey, @capgo/capacitor-social-login para el detalle de implementación en @capgo/capacitor-social-login @capgo/capacitor-passkey para el detalle de implementación en @capgo/capacitor-passkey @capgo/capacitor-native-biometric para el detalle de implementación en @capgo/capacitor-native-biometric, y Autenticación de dos factores para el detalle de implementación en Autenticación de dos factores.