Primeros pasos

Instalación

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa 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 plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:

1. Instala el paquete

   bun add @capgo/capacitor-passkey

2. Sincronizar proyectos nativos

   bunx cap sync

3. Añade 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. Instala el shim durante el bootstrap

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

• origin: origen HTTPS de la parte confiable (relying-party) principal usado por el shim y API directo
• domains: hostnames de relying party adicionales para parchear en la config nativa durante el sync
• autoShim: por defecto es true y controla el nativo cap sync hook de autoconfiguración

Lo que sync parchea por ti

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

• iOS: entitlements de associated domains y configuración de Xcode si es necesario
• Android: asset_statements metadatos y el recurso generado para el manifest

El hook no publica los archivos de confianza de tu sitio web por ti. Aún necesitas alojar:

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

Ejemplo: JSON directo API (sin shim)

Si tu backend ya devuelve WebAuthn JSON, llama a los métodos del plugin directamente.

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

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

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

Usa isSupported() before showing passkey UI on older devices.

Guías de plataforma

Configurar iOS

Associated Domains y apple-app-site-association.

Configuración de Android

Digital Asset Links y assetlinks.json.

Notas del backend

Validación de origen y advertencias de Android.

Continúa desde Getting Started

Si estás usando Primeros pasos para planificar los flujos de autenticación y de cuenta, conéctalo con Uso de @capgo/capacitor-passkey para la capacidad nativa en Uso de @capgo/capacitor-passkey, @capgo/capacitor-social-login para los detalles 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 la autenticación de dos factores.